docs: document useCondition

bpmn-io · Nov 17, 2022 · 8d73786 · 8d73786
1 parent 27cd0bc
commit 8d73786
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/packages/form-js-viewer/src/render/hooks/useCondition.js b/packages/form-js-viewer/src/render/hooks/useCondition.js
@@ -1,9 +1,12 @@
 import useService from './useService.js';
 
 /**
+ * Check if condition is met with given variables.
  *
- * @param {{ expression?: string } | undefined} condition
+ * @param {string | undefined} condition
  * @param {import('../../types').Data} data
+ *
+ * @returns {boolean} true if condition is met or no condition or condition checker exists
  */
 export function useCondition(condition, data) {
   const conditionChecker = useService('conditionChecker', false);