Heroic Lands

Interface ExpressionScopeData

The declaration behind one ExpressionScope, as authored in the plain-ESM catalog src/entity/expr/expression-scopes.mjs.

interface ExpressionScopeData {
    bindings: Readonly<Record<string, string>>;
    field: string;
    label: string;
    open?: boolean;
    result: string;
    site: string;
    summary: string;
}

Properties

bindings field label open? result site summary

Properties

bindings

bindings: Readonly<Record<string, string>>

The legal identifiers, each mapped to its authoring description.

field

field: string

The data field(s) this scope applies to — for the generated docs table.

label

label: string

Short human name, used as the generated docs-table row title.

Optionalopen

open?: boolean

When true, identifiers beyond the declared bindings are permitted (the declarations are documentation and autocomplete only). Reserved for genuinely dynamic contexts — see the event.predicate scope.

result

result: string

What the expression is expected to evaluate to.

site

site: string

Where the expression is authored — for the generated docs table.

summary

summary: string

One sentence on when this scope applies.

Settings

Member Visibility

On This Page

Properties