docs: add notes about getSchemaVariables

Closes #729
bpmn-io · Oct 13, 2023 · 0e87a13 · 0e87a13
1 parent c69357d
commit 0e87a13
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -64,6 +64,28 @@ const formPlayground = new FormPlayground({
 See [playground documentation](./packages/form-js-playground) for further details.
 
 
+### Retrieve schema variables from a form
+
+Use the `getSchemaVariables` util to retrieve the variables defined in a form schema. This is useful to gather what data is consumed and produced by a form.
+
+```javascript
+import { getSchemaVariables } from '@bpmn-io/form-js';
+
+const variables = getSchemaVariables(schema);
+
+console.log('Schema variables', variables);
+```
+
+It is also possible to distinct between input and output variables:
+
+```javascript
+import { getSchemaVariables } from '@bpmn-io/form-js';
+
+const outputVariables = getSchemaVariables(schema, { inputs: false});
+const inputVariables = getSchemaVariables(schema, { outputs: false});
+```
+
+
 ## Resources
 
 * [Demo](https://demo.bpmn.io/form)

diff --git a/packages/form-js/README.md b/packages/form-js/README.md
@@ -63,6 +63,27 @@ const formPlayground = new FormPlayground({
 
 See [playground documentation](./packages/form-js-playground) for further details.
 
+### Retrieve schema variables from a form
+
+Use the `getSchemaVariables` util to retrieve the variables defined in a form schema. This is useful to gather what data is consumed and produced by a form.
+
+```javascript
+import { getSchemaVariables } from '@bpmn-io/form-js';
+
+const variables = getSchemaVariables(schema);
+
+console.log('Schema variables', variables);
+```
+
+It is also possible to distinct between input and output variables:
+
+```javascript
+import { getSchemaVariables } from '@bpmn-io/form-js';
+
+const outputVariables = getSchemaVariables(schema, { inputs: false});
+const inputVariables = getSchemaVariables(schema, { outputs: false});
+```
+
 
 ## Resources