API Reference

IRsxOptions

Optional options object passed to rsx(expression, options).

Description

preparse, lazy, and compiled are compiler/AOT hints on expression declaration sites.

They are not runtime watcher/binding arguments. Runtime binding arguments stay on the returned binder function: (model, leafIndexWatchRule?).

Parameters

preparse?boolean

Enable/disable preparsed AST generation for this expression site.

lazy?boolean

Mark this expression site as lazy for build-time cache generation.

compiled?boolean

Enable/disable compiled-plan generation for this expression site (default true).

Defaults

preparse defaults to true.

lazy defaults to false.

compiled defaults to true.

API

export interface IRsxOptions {
  readonly preparse?: boolean;
  readonly lazy?: boolean;
  readonly compiled?: boolean;
}

Usage example

import { rsx } from '@rs-x/expression-parser';

const model = { a: 1, b: 2 };

const expr = rsx<number>('a + b', {
  preparse: true,
  lazy: false,
  compiled: true,
})(model);