docs: update

sagold · Apr 4, 2024 · 4d48dcb · 4d48dcb
1 parent a5e5988
commit 4d48dcb
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 13 deletions.
diff --git a/docs/iframe.html b/docs/iframe.html
@@ -358,4 +358,4 @@
 
       import './7334.1c190779.iframe.bundle.js';
 
-      import './main.19bf6afe.iframe.bundle.js';</script></body></html>
+      import './main.e866d94b.iframe.bundle.js';</script></body></html>
diff --git a/docs/main.19bf6afe.iframe.bundle.js b/docs/main.19bf6afe.iframe.bundle.js
diff --git a/docs/main.e866d94b.iframe.bundle.js b/docs/main.e866d94b.iframe.bundle.js
diff --git a/...ain.19bf6afe.iframe.bundle.js.LICENSE.txt → ...ain.e866d94b.iframe.bundle.js.LICENSE.txt b/...ain.19bf6afe.iframe.bundle.js.LICENSE.txt → ...ain.e866d94b.iframe.bundle.js.LICENSE.txt
diff --git a/docs/project.json b/docs/project.json
@@ -1 +1 @@
-{"generatedAt":1711445137198,"hasCustomBabel":true,"hasCustomWebpack":true,"hasStaticDirs":false,"hasStorybookEslint":true,"refCount":0,"monorepo":"Workspaces","packageManager":{"type":"yarn","version":"3.6.1"},"framework":{"name":"@storybook/react-webpack5","options":{}},"builder":"@storybook/builder-webpack5","renderer":"@storybook/react","storybookVersion":"7.0.25","storybookVersionSpecifier":"7.0.25","language":"typescript","storybookPackages":{"@storybook/addon-actions":{"version":"7.0.25"},"@storybook/addon-essentials":{"version":"7.0.25"},"@storybook/addon-interactions":{"version":"7.0.25"},"@storybook/addon-links":{"version":"7.0.25"},"@storybook/addon-mdx-gfm":{"version":"7.0.25"},"@storybook/react":{"version":"7.0.25"},"@storybook/react-webpack5":{"version":"7.0.25"},"@storybook/testing-library":{"version":"0.2.0"},"eslint-plugin-storybook":{"version":"0.6.13"},"storybook":{"version":"7.0.25"}},"addons":{"$SNIP/node_modules/@storybook/addon-links":{"version":null},"$SNIP/node_modules/@storybook/addon-essentials":{"version":null},"$SNIP/node_modules/@storybook/addon-interactions":{"version":null},"$SNIP/node_modules/@storybook/addon-mdx-gfm":{"version":null}}}
+{"generatedAt":1712222519443,"hasCustomBabel":true,"hasCustomWebpack":true,"hasStaticDirs":false,"hasStorybookEslint":true,"refCount":0,"monorepo":"Workspaces","packageManager":{"type":"yarn","version":"3.6.1"},"framework":{"name":"@storybook/react-webpack5","options":{}},"builder":"@storybook/builder-webpack5","renderer":"@storybook/react","storybookVersion":"7.0.25","storybookVersionSpecifier":"7.0.25","language":"typescript","storybookPackages":{"@storybook/addon-actions":{"version":"7.0.25"},"@storybook/addon-essentials":{"version":"7.0.25"},"@storybook/addon-interactions":{"version":"7.0.25"},"@storybook/addon-links":{"version":"7.0.25"},"@storybook/addon-mdx-gfm":{"version":"7.0.25"},"@storybook/react":{"version":"7.0.25"},"@storybook/react-webpack5":{"version":"7.0.25"},"@storybook/testing-library":{"version":"0.2.0"},"eslint-plugin-storybook":{"version":"0.6.13"},"storybook":{"version":"7.0.25"}},"addons":{"$SNIP/node_modules/@storybook/addon-links":{"version":null},"$SNIP/node_modules/@storybook/addon-essentials":{"version":null},"$SNIP/node_modules/@storybook/addon-interactions":{"version":null},"$SNIP/node_modules/@storybook/addon-mdx-gfm":{"version":null}}}
diff --git a/packages/headless-json-editor/README.md b/packages/headless-json-editor/README.md
@@ -114,34 +114,46 @@ You may work on a node-tree using the functional api. Functions that modify a tr
 
 ## node
 
-get current validation errors of node
+get current value of valueNode
 
 ```ts
-const errors: JsonError[] = node.errors;
+const value = node.value;
 ```
 
-get json-schema of value
+get type of node
 
 ```ts
-const schema: JsonSchema = node.schema;
+const nodeType: string = node.type;
 ```
 
-get options for current node
+get current json-pointer of node
 
 ```ts
-const options = node.options;
+const nodeLocation: string = node.pointer;
 ```
 
-get current value of valueNode
+get current validation errors of node
 
 ```ts
-const value = node.value;
+const errors: JsonError[] = node.errors;
+```
+
+get options for current node
+
+```ts
+const options: Record<string, any> = node.options;
 ```
 
 get children of parentNode
 
 ```ts
-const value = node.children;
+const value: Node[] = node.children;
+```
+
+get json-schema of value
+
+```ts
+const schema: JsonSchema = node.schema;
 ```