Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@camunda/feel-builtins

camunda28.2kMIT0.2.0TypeScript support: included

Collection of builtin Camunda extensions for FEEL

readme

Camunda FEEL Builtins

Collection of builtin Camunda extensions for FEEL (Friendly Enough Expression Language). These builtins get extracted from camunda-docs.

Installation

Install via npm:

npm install @camunda/feel-builtins

Usage

Feel Editor

In your FEEL editor you can use these builtins to establish the Camunda context:

import { camundaBuiltins } from '@camunda/feel-builtins';
import FeelEditor from '@bpmn-io/feel-editor';

const editor = new FeelEditor({
  container,
  builtins: camundaBuiltins,
  parserDialect: 'camunda'
});

Feel Lint

With @bpmn-io/feel-lint you can also use the builtins to lint expressions in the Camunda world:

import { camundaBuiltins } from '@camunda/feel-builtins';
import { lintExpression } from '@bpmn-io/feel-lint';

lintExpression(expression, {
  builtins: camundaBuiltins,
  parserDialect: 'camunda'
});

Resources

Build and Run

Prepare the project by installing dependencies:

npm install

Then, depending on your use-case you may run any of the following commands:

# lint the library and run all tests
npm run all

# update the built-ins from latest camunda-docs
npm run update-builtins

License

MIT

changelog

Changelog

All notable changes to @camunda/feel-builtins are documented here. We use semantic versioning for releases.

Unreleased

_Note: Yet to be released changes appear here._

0.2.0

  • FEAT: generate CJS distribution (#6)

0.1.0

  • FEAT: initial release, import camundaBuiltins from @bpmn-io/feel-editor (#1)