@bpmn-io/moddle-utils

Utils for moddle. 🛠️

API

getPath

1import { getPath } from '@bpmn-io/moddle-utils';
2
3// global
4getPath(moddleElement); // [ 'rootElements', 0, 'flowElements', 0, 'extensionElements', 'values', 0 ]
5
6// local
7getPath(moddleElement, parentModdleElement); // [ 'extensionElements', 'values', 0 ]
8
9// $parent === undefined
10const task = moddle.create('bpmn:Task');
11
12getPath(task); // null
13
14// null
15getPath(null); // null

pathConcat

1import { pathConcat } from '@bpmn-io/moddle-utils';
2
3pathConcat([ 'foo', 'bar' ], 'baz'); // [ 'foo', 'bar', 'baz' ]
4
5// null
6pathConcat([ 'foo', 'bar' ], null); // null

pathEquals

1import { pathEquals } from '@bpmn-io/moddle-utils';
2
3// default separator
4pathEquals('extensionElements.values.0.type', 'extensionElements.values.0.type'); // true
5
6pathEquals([ 'extensionElements', 'values', 0 ], [ 'extensionElements', 'values', 0 ]); // true
7
8// custom separator
9pathEquals('extensionElements-values-0-type', 'extensionElements-values-0-type', '-'); // true
10
11// null
12pathEquals(null, [ 'foo' ]); // false

parsePath

1import { parsePath } from '@bpmn-io/moddle-utils';
2
3// default separator
4parsePath('rootElements.0.flowElements.0.extensionElements.values.0.type'); // [ 'rootElements', 0, 'flowElements', 0, 'extensionElements', 'values', 0 ]
5
6// custom separator
7parsePath('rootElements-0-flowElements-0-extensionElements-values-0-type', '-'); // [ 'rootElements', 0, 'flowElements', 0, 'extensionElements', 'values', 0 ]
8
9// null
10parsePath(null); // null

stringifyPath

1import { stringifyPath } from '@bpmn-io/moddle-utils';
2
3// default separator
4stringifyPath([ 'rootElements', 0, 'flowElements', 0, 'extensionElements', 'values', 0 ]); // 'rootElements.0.flowElements.0.extensionElements.values.0.type'
5
6// custom separator
7stringifyPath([ 'rootElements', 0, 'flowElements', 0, 'extensionElements', 'values', 0 ], '-'); // 'rootElements-0-flowElements-0-extensionElements-values-0-type'
8
9// null
10stringifyPath(null); // null

Licence

MIT