From 86ac19616dfaf1d52307d67fef389022f1ada3af Mon Sep 17 00:00:00 2001 From: geoffhendrey Date: Mon, 6 Jan 2025 04:03:04 +0000 Subject: [PATCH] deploy: 534d7296c424de08cd3eb69773680843590c481b --- classes/CliCore.default.html | 12 +-- classes/CliCoreBase.CliCoreBase.html | 12 +-- classes/ConsoleLogger.default.html | 4 +- classes/DataFlow.DataFlow.html | 10 +-- classes/DependencyFinder.default.html | 8 +- classes/ExecutionStatus.ExecutionStatus.html | 6 +- classes/FancyLogger.default.html | 4 +- classes/JsonPointer.default.html | 26 +++--- .../LifecycleManager.LifecycleManager.html | 10 +-- classes/MetaInfoProducer.default.html | 4 +- ...nDefault.ParallelExecutionPlanDefault.html | 24 +++--- classes/ParallelPlanner.ParallelPlanner.html | 20 ++--- classes/SerialPlanner.SerialPlanner.html | 20 ++--- classes/StatedREPL.default.html | 4 +- classes/TemplateProcessor.default.html | 86 +++++++++---------- classes/TimerManager.TimerManager.html | 4 +- classes/TraversalState.TraversalState.html | 6 +- classes/VizGraph.default.html | 4 +- enums/Lifecycle.LifecycleState.html | 12 +-- ...rallelExecutionPlanDefault.isMutation.html | 2 +- ...tUtils.parseMarkdownAndTestCodeblocks.html | 2 +- functions/TestUtils.parseMarkdownTests.html | 2 +- functions/index.stringifyTemplateJSON.html | 2 +- interfaces/ConsoleLogger.StatedLogger.html | 4 +- interfaces/Lifecycle.LifecycleOwner.html | 6 +- interfaces/MetaInfoProducer.MetaInfo.html | 4 +- ...elExecutionPlan.ParallelExecutionPlan.html | 24 +++--- interfaces/Planner.ExecutionPlan.html | 16 ++-- interfaces/Planner.Planner.html | 14 +-- interfaces/SerialPlanner.SerialPlan.html | 16 ++-- modules/CliCore.html | 2 +- modules/CliCoreBase.html | 2 +- modules/ConsoleLogger.html | 2 +- modules/DataFlow.html | 2 +- modules/DependencyFinder.html | 2 +- modules/ExecutionStatus.html | 2 +- modules/FancyLogger.html | 2 +- modules/JsonPointer.html | 2 +- modules/Lifecycle.html | 2 +- modules/LifecycleManager.html | 2 +- modules/MetaInfoProducer.html | 2 +- modules/ParallelExecutionPlan.html | 2 +- modules/ParallelExecutionPlanDefault.html | 2 +- modules/ParallelPlanner.html | 2 +- modules/Planner.html | 2 +- modules/SerialPlanner.html | 2 +- modules/StatedREPL.html | 2 +- modules/TemplateProcessor.html | 2 +- modules/TestUtils.html | 2 +- modules/TimerManager.html | 2 +- modules/TraversalState.html | 2 +- modules/VizGraph.html | 2 +- modules/index.html | 2 +- types/ConsoleLogger.Levels.html | 2 +- types/ConsoleLogger.LogLevel.html | 2 +- types/DataFlow.DataFlowNode.html | 2 +- types/DataFlow.FlowOpt.html | 2 +- types/JsonPointer.DescentCallback.html | 2 +- types/JsonPointer.DescentIterator.html | 2 +- types/Lifecycle.LifecycleCallback.html | 2 +- types/MetaInfoProducer.JsonPointerString.html | 2 +- ...nfoProducer.JsonPointerStructureArray.html | 2 +- ...ecutionPlanDefault.MutationParamsType.html | 2 +- types/Planner.SerializableExecutionPlan.html | 2 +- .../TemplateProcessor.DataChangeCallback.html | 2 +- types/TemplateProcessor.Fork.html | 2 +- types/TemplateProcessor.ForkId.html | 2 +- .../TemplateProcessor.FunctionGenerator.html | 2 +- types/TemplateProcessor.MetaInfoMap.html | 2 +- types/TemplateProcessor.Mutation.html | 2 +- types/TemplateProcessor.Op.html | 2 +- types/TemplateProcessor.PlanStep.html | 2 +- types/TemplateProcessor.Snapshot.html | 2 +- types/TemplateProcessor.StatedError.html | 2 +- types/TemplateProcessor.Transaction.html | 2 +- types/TestUtils.CommandAndResponse.html | 2 +- variables/ConsoleLogger.LOG_LEVELS.html | 2 +- 77 files changed, 231 insertions(+), 231 deletions(-) diff --git a/classes/CliCore.default.html b/classes/CliCore.default.html index cf524aa8..8bbffa92 100644 --- a/classes/CliCore.default.html +++ b/classes/CliCore.default.html @@ -1,6 +1,6 @@ default | stated-js

Class default

Base class for building CLIs. By itself can be used for a CLI that does not support the tail command. Tail command uses Node repl class that is not implemented in other JS runtimes such as Bun. CliCoreBase should run in Bun.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

currentDirectory onInit replServer @@ -32,18 +32,18 @@ parseInitArgs readFileAndParse resolveImportPath -

Constructors

constructor

Properties

Protected currentDirectory

currentDirectory: string

onInit

onInit: (() => void | Promise<void>)

Type declaration

    • (): void | Promise<void>

    • Returns void | Promise<void>

replServer

replServer: REPLServer

Protected templateProcessor

templateProcessor: default

Methods

cd

close

color

  • color(): void

  • this method is just here as a stub to allow tests to pass. Color is in reality handled only by StatedRepl, +

Constructors

constructor

Properties

Protected currentDirectory

currentDirectory: string

onInit

onInit: (() => void | Promise<void>)

Type declaration

    • (): void | Promise<void>

    • Returns void | Promise<void>

replServer

replServer: REPLServer

Protected templateProcessor

templateProcessor: default

Methods

cd

close

color

  • color(): void

  • this method is just here as a stub to allow tests to pass. Color is in reality handled only by StatedRepl, it is not something that is possible to 'see' from the CLI since CLI returns pure JSON which has no concept of terminal colors.

    -

    Returns void

debug

errors

Protected extractArgsInfo

  • extractArgsInfo(args): {
        format: string;
        jsonPointer: string;
        jsonataExpression: undefined;
        number: number;
    } | {
        format: string;
        jsonPointer: string;
        jsonataExpression: string;
        number?: undefined;
    }

  • Parameters

    • args: string

    Returns {
        format: string;
        jsonPointer: string;
        jsonataExpression: undefined;
        number: number;
    } | {
        format: string;
        jsonPointer: string;
        jsonataExpression: string;
        number?: undefined;
    }

flow

from

getTemplateProcessor

in

init

  • init(replCmdInputStr, fromSnapshot?): Promise<any>

  • This Cli core command may be invoked directly from the REPL init command or from restore command

    +

    Returns void

debug

errors

Protected extractArgsInfo

  • extractArgsInfo(args): {
        format: string;
        jsonPointer: string;
        jsonataExpression: undefined;
        number: number;
    } | {
        format: string;
        jsonPointer: string;
        jsonataExpression: string;
        number?: undefined;
    }

  • Parameters

    • args: string

    Returns {
        format: string;
        jsonPointer: string;
        jsonataExpression: undefined;
        number: number;
    } | {
        format: string;
        jsonPointer: string;
        jsonataExpression: string;
        number?: undefined;
    }

flow

from

getTemplateProcessor

in

init

  • init(replCmdInputStr, fromSnapshot?): Promise<any>

  • This Cli core command may be invoked directly from the REPL init command or from restore command

    • fromSnapshot=false, replCmdInoutStr example: -f "example/ex23.json" --tags=["PEACE"] --xf=example/myEnv.json
    • fromSnapshot=true, replCmdInoutStr example: -f "example/restoreSnapshot.json" --tags=["PEACE"] --xf=example/myEnv.json

    Parameters

    • replCmdInputStr: string
    • fromSnapshot: boolean = false

      when set to true, template processor will treat input as a snapshot of a previous templateProcessor state

      -

    Returns Promise<any>

log

note

open

  • open(directory?): Promise<"open... (type 'abort' to cancel)" | {
        error: string;
    }>

  • Parameters

    • directory: string = ...

    Returns Promise<"open... (type 'abort' to cancel)" | {
        error: string;
    }>

out

plan

restore

  • restore(replCmdInputStr): Promise<any>

  • replCmdInoutStr example: -f "example/restoreSnapshot.json" --tags=["PEACE"] --xf=example/myEnv.json

    +

Returns Promise<any>

log

note

open

  • open(directory?): Promise<"open... (type 'abort' to cancel)" | {
        error: string;
    }>

  • Parameters

    • directory: string = ...

    Returns Promise<"open... (type 'abort' to cancel)" | {
        error: string;
    }>

out

plan

restore

  • restore(replCmdInputStr): Promise<any>

  • replCmdInoutStr example: -f "example/restoreSnapshot.json" --tags=["PEACE"] --xf=example/myEnv.json

    Parameters

    • replCmdInputStr: string

      the command line string that will be parsed into arguments

      -

    Returns Promise<any>

set

state

svg

tail

to

Static isNodeEnvironment

Static minimistArgs

Static parseInitArgs

  • parseInitArgs(replCmdInputStr): {
        --?: string[];
        _: string[];
        ctx: any;
        filepath: any;
        oneshot: any;
        options: any;
        tags: any;
    }

  • Parameters

    • replCmdInputStr: string

    Returns {
        --?: string[];
        _: string[];
        ctx: any;
        filepath: any;
        oneshot: any;
        options: any;
        tags: any;
    }

    • Optional --?: string[]

      If opts['--'] is true, populated with everything after the --

      +

Returns Promise<any>

set

state

svg

tail

to

Static isNodeEnvironment

Static minimistArgs

Static parseInitArgs

Static readFileAndParse

Static resolveImportPath

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +
  • ctx: any
  • filepath: any
  • oneshot: any
  • options: any
  • tags: any

    • Static readFileAndParse

    Static resolveImportPath

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/CliCoreBase.CliCoreBase.html b/classes/CliCoreBase.CliCoreBase.html index a66dbf38..1fb40506 100644 --- a/classes/CliCoreBase.CliCoreBase.html +++ b/classes/CliCoreBase.CliCoreBase.html @@ -1,6 +1,6 @@ CliCoreBase | stated-js

    Class CliCoreBase

    Base class for building CLIs. By itself can be used for a CLI that does not support the tail command. Tail command uses Node repl class that is not implemented in other JS runtimes such as Bun. CliCoreBase should run in Bun.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    currentDirectory logLevel onInit @@ -33,18 +33,18 @@ parseInitArgs readFileAndParse resolveImportPath -

    Constructors

    constructor

    Properties

    Protected currentDirectory

    currentDirectory: string

    Private logLevel

    logLevel: keyof LogLevel

    onInit

    onInit: (() => void | Promise<void>)

    Type declaration

      • (): void | Promise<void>

      • Returns void | Promise<void>

    Private server

    server: Server<typeof IncomingMessage, typeof ServerResponse>

    Protected templateProcessor

    templateProcessor: default

    Methods

    cd

    close

    color

    • color(): void

    • this method is just here as a stub to allow tests to pass. Color is in reality handled only by StatedRepl, +

    Constructors

    constructor

    Properties

    Protected currentDirectory

    currentDirectory: string

    Private logLevel

    logLevel: keyof LogLevel

    onInit

    onInit: (() => void | Promise<void>)

    Type declaration

      • (): void | Promise<void>

      • Returns void | Promise<void>

    Private server

    server: Server<typeof IncomingMessage, typeof ServerResponse>

    Protected templateProcessor

    templateProcessor: default

    Methods

    cd

    close

    color

    • color(): void

    • this method is just here as a stub to allow tests to pass. Color is in reality handled only by StatedRepl, it is not something that is possible to 'see' from the CLI since CLI returns pure JSON which has no concept of terminal colors.

      -

      Returns void

    debug

    • debug(replCmdInputStr): Promise<any>

    • Parameters

      • replCmdInputStr: string

      Returns Promise<any>

    errors

    Protected extractArgsInfo

    • extractArgsInfo(args): {
          format: string;
          jsonPointer: string;
          jsonataExpression: undefined;
          number: number;
      } | {
          format: string;
          jsonPointer: string;
          jsonataExpression: string;
          number?: undefined;
      }

    • Parameters

      • args: string

      Returns {
          format: string;
          jsonPointer: string;
          jsonataExpression: undefined;
          number: number;
      } | {
          format: string;
          jsonPointer: string;
          jsonataExpression: string;
          number?: undefined;
      }

    flow

    from

    getTemplateProcessor

    in

    init

    • init(replCmdInputStr, fromSnapshot?): Promise<any>

    • This Cli core command may be invoked directly from the REPL init command or from restore command

      +

      Returns void

    debug

    • debug(replCmdInputStr): Promise<any>

    • Parameters

      • replCmdInputStr: string

      Returns Promise<any>

    errors

    Protected extractArgsInfo

    • extractArgsInfo(args): {
          format: string;
          jsonPointer: string;
          jsonataExpression: undefined;
          number: number;
      } | {
          format: string;
          jsonPointer: string;
          jsonataExpression: string;
          number?: undefined;
      }

    • Parameters

      • args: string

      Returns {
          format: string;
          jsonPointer: string;
          jsonataExpression: undefined;
          number: number;
      } | {
          format: string;
          jsonPointer: string;
          jsonataExpression: string;
          number?: undefined;
      }

    flow

    from

    getTemplateProcessor

    in

    init

    • init(replCmdInputStr, fromSnapshot?): Promise<any>

    • This Cli core command may be invoked directly from the REPL init command or from restore command

      • fromSnapshot=false, replCmdInoutStr example: -f "example/ex23.json" --tags=["PEACE"] --xf=example/myEnv.json
      • fromSnapshot=true, replCmdInoutStr example: -f "example/restoreSnapshot.json" --tags=["PEACE"] --xf=example/myEnv.json

      Parameters

      • replCmdInputStr: string
      • fromSnapshot: boolean = false

        when set to true, template processor will treat input as a snapshot of a previous templateProcessor state

        -

      Returns Promise<any>

    log

    note

    Private openFile

    out

    • out(replCmdInputStr): null | object

    • Parameters

      • replCmdInputStr: string

      Returns null | object

    plan

    restore

    • restore(replCmdInputStr): Promise<any>

    • replCmdInoutStr example: -f "example/restoreSnapshot.json" --tags=["PEACE"] --xf=example/myEnv.json

      +

    Returns Promise<any>

    log

    note

    Private openFile

    out

    • out(replCmdInputStr): null | object

    • Parameters

      • replCmdInputStr: string

      Returns null | object

    plan

    restore

    • restore(replCmdInputStr): Promise<any>

    • replCmdInoutStr example: -f "example/restoreSnapshot.json" --tags=["PEACE"] --xf=example/myEnv.json

      Parameters

      • replCmdInputStr: string

        the command line string that will be parsed into arguments

        -

      Returns Promise<any>

    set

    state

    svg

    tail

    to

    Static isNodeEnvironment

    Static minimistArgs

    • minimistArgs(replCmdInputStr): ParsedArgs

    • Parameters

      • replCmdInputStr: string

      Returns ParsedArgs

    Static parseInitArgs

    • parseInitArgs(replCmdInputStr): {
          --?: string[];
          _: string[];
          ctx: any;
          filepath: any;
          oneshot: any;
          options: any;
          tags: any;
      }

    • Parameters

      • replCmdInputStr: string

      Returns {
          --?: string[];
          _: string[];
          ctx: any;
          filepath: any;
          oneshot: any;
          options: any;
          tags: any;
      }

      • Optional --?: string[]

        If opts['--'] is true, populated with everything after the --

        +

    Returns Promise<any>

    set

    state

    svg

    tail

    to

    Static isNodeEnvironment

    Static minimistArgs

    Static parseInitArgs

    Static readFileAndParse

    Static resolveImportPath

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • ctx: any
  • filepath: any
  • oneshot: any
  • options: any
  • tags: any

    • Static readFileAndParse

    Static resolveImportPath

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ConsoleLogger.default.html b/classes/ConsoleLogger.default.html index 9d86cef2..01a25214 100644 --- a/classes/ConsoleLogger.default.html +++ b/classes/ConsoleLogger.default.html @@ -1,4 +1,4 @@ -default | stated-js

    Class default

    Implements

    Constructors

    constructor +default | stated-js

    Class default

    Implements

    Constructors

    constructor

    Properties

    level

    Methods

    debug error @@ -6,4 +6,4 @@ log verbose warn -

    Constructors

    constructor

    Properties

    level

    level: Levels

    Methods

    debug

    error

    info

    log

    verbose

    warn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    level

    level: Levels

    Methods

    debug

    error

    info

    log

    verbose

    warn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/DataFlow.DataFlow.html b/classes/DataFlow.DataFlow.html index 62b257db..5424230b 100644 --- a/classes/DataFlow.DataFlow.html +++ b/classes/DataFlow.DataFlow.html @@ -1,12 +1,12 @@ DataFlow | stated-js

    Class DataFlow

    Class representing a DataFlow, managing dependencies and data flow nodes.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    roots templateProcessor visited

    Methods

    getRoots level1Compact linkDependees -

    Constructors

    constructor

    Properties

    Private roots

    roots: Set<DataFlowNode>

    Private templateProcessor

    templateProcessor: default

    Private visited

    visited: Map<MetaInfo, DataFlowNode>

    Methods

    getRoots

    • getRoots(level?): DataFlowNode[]

    • Retrieves the roots of the data flow nodes based on the specified option.

      +

    Constructors

    constructor

    Properties

    Private roots

    roots: Set<DataFlowNode>

    Private templateProcessor

    templateProcessor: default

    Private visited

    visited: Map<MetaInfo, DataFlowNode>

    Methods

    getRoots

    • getRoots(level?): DataFlowNode[]

    • Retrieves the roots of the data flow nodes based on the specified option.

      Parameters

      • level: FlowOpt = 0

        The option for retrieving roots, it can be either "l0" or "l1". "l0" returns the roots as they are. "l1" returns the roots in a compacted form.

        @@ -16,14 +16,14 @@

        Throws

        • Throws an error if the specified option is unknown.
        -

    Private level1Compact

    Private level1Compact

    • level1Compact(node): DataFlowNode

    • Recursively compacts the given DataFlowNode, reducing the 'to' field to a single object if there is only one child node, or omitting it if there are no child nodes.

      Parameters

      • node: DataFlowNode

        The node to compact. This node may have a 'to' field that is an array of child nodes.

      Returns DataFlowNode

      The compacted node, which may have a simplified 'to' field or none at all.

      -

    Private linkDependees

    • linkDependees(metaInfo): DataFlowNode

    • Links the given metaInfo node with its dependees, creating and returning a new DataFlowNode.

      +

    Private linkDependees

    • linkDependees(metaInfo): DataFlowNode

    • Links the given metaInfo node with its dependees, creating and returning a new DataFlowNode.

      Parameters

      • metaInfo: MetaInfo

        The metadata information object containing dependencies and location data.

      Returns DataFlowNode

      • The created DataFlowNode with linked dependees.
      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/DependencyFinder.default.html b/classes/DependencyFinder.default.html index 4a40c28e..633c31e7 100644 --- a/classes/DependencyFinder.default.html +++ b/classes/DependencyFinder.default.html @@ -1,4 +1,4 @@ -default | stated-js

    Class default

    Constructors

    constructor +default | stated-js

    Class default

    Constructors

    constructor

    Properties

    ast compiledExpression currentSteps @@ -24,10 +24,10 @@ peek stepsRootedIn$

    Constructors

    constructor

    Properties

    Private ast

    ast: ExprNode

    compiledExpression

    compiledExpression: Expression

    Private Readonly currentSteps

    currentSteps: StepRecord[][]

    Private Readonly dependencies

    dependencies: string[][]

    Private nodeStack

    nodeStack: GeneratedExprNode[]

    Readonly variables

    variables: Set<string> = ...

    Methods

    ancestors

    captureArrayIndexes

    Private captureBuiltInFunctionNames

    • captureBuiltInFunctionNames(node): void
    • Private

      Function calls like $count(...) are recorded in this.variables so that the MetaInf can have a record +

      Parameters

      • program: string | ExprNode

      Returns default

    Properties

    Private ast

    ast: ExprNode

    compiledExpression

    compiledExpression: Expression

    Private Readonly currentSteps

    currentSteps: StepRecord[][]

    Private Readonly dependencies

    dependencies: string[][]

    Private nodeStack

    nodeStack: GeneratedExprNode[]

    Readonly variables

    variables: Set<string> = ...

    Methods

    ancestors

    captureArrayIndexes

    Private captureBuiltInFunctionNames

    • captureBuiltInFunctionNames(node): void
    • Private

      Function calls like $count(...) are recorded in this.variables so that the MetaInf can have a record of what context variables (in this case functions) were accessed by the expression.

      -

      Parameters

      • node: GeneratedExprNode

      Returns void

    capturePathExpressions

    collectChildren

    • collectChildren(node): GeneratedExprNode[]

    • Parameters

      • node: GeneratedExprNode

      Returns GeneratedExprNode[]

    emitPaths

    findDependencies

    hasAncestor

    hasParent

    isInsideAScopeWhere$IsLocal

    isRootedIn$$

    isSingle$Var

    Private markScopeWhenFunctionReturnsValue

    • markScopeWhenFunctionReturnsValue(scopeWeExited): void

    • Parameters

      • scopeWeExited: GeneratedExprNode

      Returns void

    withAstFilterExpression

    • withAstFilterExpression(jsonatExpr): Promise<default>

    • If we are looking to analyze only a portion of the jsonata program we can provide another jsonata expression +

      Parameters

      • node: GeneratedExprNode

      Returns void

    capturePathExpressions

    collectChildren

    • collectChildren(node): GeneratedExprNode[]

    • Parameters

      • node: GeneratedExprNode

      Returns GeneratedExprNode[]

    emitPaths

    findDependencies

    hasAncestor

    hasParent

    isInsideAScopeWhere$IsLocal

    isRootedIn$$

    isSingle$Var

    Private markScopeWhenFunctionReturnsValue

    • markScopeWhenFunctionReturnsValue(scopeWeExited): void

    • Parameters

      • scopeWeExited: GeneratedExprNode

      Returns void

    withAstFilterExpression

    • withAstFilterExpression(jsonatExpr): Promise<default>

    • If we are looking to analyze only a portion of the jsonata program we can provide another jsonata expression such as '[procedure.value='serial']' which will filter the AST down to what is defined. In the case of '[procedure.value='serial']' the expression will extract the AST for $serial(...) as it may exist in the original program.

      -

      Parameters

      • jsonatExpr: string

      Returns Promise<default>

    Static emit

    Static isNoOpSteps

    Static peek

    Static stepsRootedIn$

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • jsonatExpr: string

    Returns Promise<default>

    Static emit

    Static isNoOpSteps

    Static peek

    Static stepsRootedIn$

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ExecutionStatus.ExecutionStatus.html b/classes/ExecutionStatus.ExecutionStatus.html index 0629d9cb..0d8fb4de 100644 --- a/classes/ExecutionStatus.ExecutionStatus.html +++ b/classes/ExecutionStatus.ExecutionStatus.html @@ -1,4 +1,4 @@ -ExecutionStatus | stated-js

    Class ExecutionStatus

    Constructors

    constructor +ExecutionStatus | stated-js

    Class ExecutionStatus

    Constructors

    constructor

    Properties

    metaInfoByJsonPointer plans tp @@ -10,7 +10,7 @@ toJsonString fromJsonObject fromJsonString -

    Constructors

    constructor

    Properties

    metaInfoByJsonPointer

    metaInfoByJsonPointer: MetaInfoMap

    plans

    plans: Set<ExecutionPlan>

    tp

    tp: default

    Methods

    begin

    clear

    end

    getForkMap

    toJsonObject

    toJsonString

    Static fromJsonObject

    • fromJsonObject(tp, snapshot): ExecutionStatus

    • Reconstructs execution status and template processor internal states form an execution status snapshot

      +

    Constructors

    constructor

    Properties

    metaInfoByJsonPointer

    metaInfoByJsonPointer: MetaInfoMap

    plans

    plans: Set<ExecutionPlan>

    tp

    tp: default

    Methods

    begin

    clear

    end

    getForkMap

    toJsonObject

    toJsonString

    Static fromJsonObject

    Static fromJsonString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns ExecutionStatus

    Static fromJsonString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/FancyLogger.default.html b/classes/FancyLogger.default.html index edaac5ff..bf3cbf76 100644 --- a/classes/FancyLogger.default.html +++ b/classes/FancyLogger.default.html @@ -1,3 +1,3 @@ -default | stated-js

    Class default

    Constructors

    constructor +default | stated-js

    Class default

    Constructors

    constructor

    Methods

    getLogger -

    Constructors

    constructor

    Methods

    Static getLogger

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Methods

    Static getLogger

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/JsonPointer.default.html b/classes/JsonPointer.default.html index 016a5fe6..be0aa28b 100644 --- a/classes/JsonPointer.default.html +++ b/classes/JsonPointer.default.html @@ -1,4 +1,4 @@ -default | stated-js

    Class default

    Constructors

    constructor +default | stated-js

    Class default

    Constructors

    constructor

    Methods

    api compile dict @@ -17,19 +17,19 @@ Calls .get when called with an object and a pointer. Calls .set when also called with value. If only supplied object, returns a partially applied function, mapped to the object.

    -

    Parameters

    Returns any

    Static compile

    Static dict

    Static escape

    • escape(str): string

    • Escapes a reference token

      -

      Parameters

      • str: string | number

      Returns string

    Static get

    Static has

    Static isAncestor

    Static compile

    Static dict

    Static escape

    • escape(str): string

    • Escapes a reference token

      +

      Parameters

      • str: string | number

      Returns string

    Static get

    Static has

    Static isAncestor

    • isAncestor(jsonPtr, potentialAncestor): boolean

    • Returns true if potentialAncestor is an ancestor of jsonPtr. For example, if jsonPtr is /a/b/c/d and potentialAncestor is /a/b, this returns true.

      Parameters

      • jsonPtr: string

        The JSON pointer to check.

      • potentialAncestor: string

        The potential ancestor JSON pointer.

        -

      Returns boolean

    Static parent

    Static parse

    • parse(pointer): string[]

    • Converts a JSON pointer into an array of reference tokens

      -

      Parameters

      • pointer: string

      Returns string[]

    Static remove

    Static rootish

    Static set

    Static unescape

    • unescape(str): string

    • Unescapes a reference token

      -

      Parameters

      • str: string

      Returns string

    Static walk

    • walk(obj, iterator, descend?): void

    • Iterates over an object +

    Returns boolean

    Static parent

    Static parse

    • parse(pointer): string[]

    • Converts a JSON pointer into an array of reference tokens

      +

      Parameters

      • pointer: string

      Returns string[]

    Static remove

    Static rootish

    Static set

    Static unescape

    • unescape(str): string

    • Unescapes a reference token

      +

      Parameters

      • str: string

      Returns string

    Static walk

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/LifecycleManager.LifecycleManager.html b/classes/LifecycleManager.LifecycleManager.html index 13ea6853..a5cd0986 100644 --- a/classes/LifecycleManager.LifecycleManager.html +++ b/classes/LifecycleManager.LifecycleManager.html @@ -1,17 +1,17 @@ LifecycleManager | stated-js

    Class LifecycleManager

    Class for managing lifecycle callbacks.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    lifecycleCallbacks templateProcessor

    Methods

    clear removeLifecycleCallback runCallbacks setLifecycleCallback -

    Constructors

    constructor

    Properties

    Private lifecycleCallbacks

    lifecycleCallbacks: Map<LifecycleState, Set<LifecycleCallback>>

    Private templateProcessor

    templateProcessor: default

    Methods

    clear

    removeLifecycleCallback

    • removeLifecycleCallback(state, cbFn?): void

    • Removes a specific lifecycle callback or all callbacks for a lifecycle state.

      +

    Constructors

    constructor

    Properties

    Private lifecycleCallbacks

    lifecycleCallbacks: Map<LifecycleState, Set<LifecycleCallback>>

    Private templateProcessor

    templateProcessor: default

    Methods

    clear

    removeLifecycleCallback

    runCallbacks

    • runCallbacks(state): Promise<void>

    • Calls all lifecycle callbacks registered for a specific lifecycle state.

      +

    Returns void

    runCallbacks

    • runCallbacks(state): Promise<void>

    • Calls all lifecycle callbacks registered for a specific lifecycle state.

      Parameters

      Returns Promise<void>

    setLifecycleCallback

    • setLifecycleCallback(state, cbFn): void

    • Registers a lifecycle callback for a specific lifecycle state.

      +

    Returns Promise<void>

    setLifecycleCallback

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/MetaInfoProducer.default.html b/classes/MetaInfoProducer.default.html index 975b63af..930d0487 100644 --- a/classes/MetaInfoProducer.default.html +++ b/classes/MetaInfoProducer.default.html @@ -1,4 +1,4 @@ -default | stated-js

    Class default

    Constructors

    constructor +default | stated-js

    Class default

    Constructors

    constructor

    Properties

    EMBEDDED_EXPR_REGEX

    Methods

    getMetaInfos -

    Constructors

    constructor

    Properties

    Static EMBEDDED_EXPR_REGEX

    EMBEDDED_EXPR_REGEX: RegExp = ...

    Methods

    Static getMetaInfos

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Static EMBEDDED_EXPR_REGEX

    EMBEDDED_EXPR_REGEX: RegExp = ...

    Methods

    Static getMetaInfos

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ParallelExecutionPlanDefault.ParallelExecutionPlanDefault.html b/classes/ParallelExecutionPlanDefault.ParallelExecutionPlanDefault.html index 3156b74b..168814d9 100644 --- a/classes/ParallelExecutionPlanDefault.ParallelExecutionPlanDefault.html +++ b/classes/ParallelExecutionPlanDefault.ParallelExecutionPlanDefault.html @@ -1,7 +1,7 @@ ParallelExecutionPlanDefault | stated-js

    Class ParallelExecutionPlanDefault

    Represents a parallel execution plan that can be executed concurrently. This interface extends both ExecutionPlan and PlanStep to provide functionality for parallel processing of template operations.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    completed data didUpdate @@ -17,21 +17,21 @@ getPointer toJSON _toJSON -

    Constructors

    constructor

    Properties

    completed

    completed: boolean = false

    Indicates whether the entire execution subtree rooted at this node has finished processing. +

    Constructors

    constructor

    Properties

    completed

    completed: boolean = false

    Indicates whether the entire execution subtree rooted at this node has finished processing. When true, all child nodes in the parallel array have also completed their execution.

    -

    data

    data: any

    The data associated with the plan. May be undefined for initialization plans.

    -

    didUpdate

    didUpdate: boolean = false

    forkId

    forkId: string = "ROOT"

    The identifier for the fork associated with this execution plan. Will be "ROOT" when the plan is not +

    data

    data: any

    The data associated with the plan. May be undefined for initialization plans.

    +

    didUpdate

    didUpdate: boolean = false

    forkId

    forkId: string = "ROOT"

    The identifier for the fork associated with this execution plan. Will be "ROOT" when the plan is not executing a fork

    -

    forkStack

    forkStack: Fork[] = []

    The stack of forks involved in this execution plan. Forks will push and pop on top of the ROOT fork +

    forkStack

    forkStack: Fork[] = []

    The stack of forks involved in this execution plan. Forks will push and pop on top of the ROOT fork corresponding to entering a $forked() and exiting a forked plan on $joined()

    -

    jsonPtr

    jsonPtr: string = "/"

    A JSON Pointer string that identifies the location in the template being processed. +

    jsonPtr

    jsonPtr: string = "/"

    A JSON Pointer string that identifies the location in the template being processed. This pointer is used to track and reference specific nodes in the template structure.

    -

    op

    op: Op = "initialize"

    The operation to perform. If present and op is "set", the data is applied +

    op

    op: Op = "initialize"

    The operation to perform. If present and op is "set", the data is applied to the first JSON pointer.

    -

    output

    output: any

    The output object associated with the execution plan.

    -

    parallel

    parallel: ParallelExecutionPlan[]

    An array of child ParallelExecutionPlan nodes that can be executed in parallel. +

    output

    output: any

    The output object associated with the execution plan.

    +

    parallel

    parallel: ParallelExecutionPlan[]

    An array of child ParallelExecutionPlan nodes that can be executed in parallel. This forms the root node of a directed acyclic graph (DAG) of ParallelPlanStep's.

    -

    Optional restore

    restore?: boolean = false

    Optional flag used to mark plans that are being used during a restore operation. +

    Optional restore

    restore?: boolean = false

    Optional flag used to mark plans that are being used during a restore operation. When true, indicates that this plan is part of restoring a previous template state.

    -

    Methods

    cleanCopy

    getNodeList

    getPointer

    toJSON

    Static Private _toJSON

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    cleanCopy

    getNodeList

    getPointer

    toJSON

    Static Private _toJSON

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ParallelPlanner.ParallelPlanner.html b/classes/ParallelPlanner.ParallelPlanner.html index 8c4cb10f..db35a790 100644 --- a/classes/ParallelPlanner.ParallelPlanner.html +++ b/classes/ParallelPlanner.ParallelPlanner.html @@ -1,6 +1,6 @@ ParallelPlanner | stated-js

    Class ParallelPlanner

    Interface representing a Planner responsible for generating and executing initialization and mutation plans for templates in a TemplateProcessor.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    planCache tp

    Methods

    dedupLeaves @@ -26,28 +26,28 @@ stepIsDescendantOfMutationTarget toJSON validatePlan -

    Constructors

    constructor

    Properties

    Private planCache

    planCache: Map<string, [ExecutionPlan, string[]]> = ...

    Private tp

    tp: default

    Methods

    Private dedupLeaves

    • dedupLeaves(node): void
    • Private

      There are situations when an expression can result in multiple parallel paths to the same node. +

    Constructors

    constructor

    Properties

    Private planCache

    planCache: Map<string, [ExecutionPlan, string[]]> = ...

    Private tp

    tp: default

    Methods

    Private dedupLeaves

    • dedupLeaves(node): void
    • Private

      There are situations when an expression can result in multiple parallel paths to the same node. For example like ${a + a.b + a.c} where a is an expression (thus a.b and a.c are not materialized__) will result in parallel containing three nodes of '/a'. that cause

      -

      Parameters

      Returns void

    execute

    execute

    • execute(plan): Promise<void>

    • Executes the specified execution plan.

      This method runs any plan that the Planner has generated, applying its operations to the template or its components.

      Parameters

      Returns Promise<void>

      A promise that resolves once execution is complete.

      -

    executeDataChangeCallbacks

    from

    • from(jsonPtr): string[]

    • to preserve backward compatibility of the from command, the parallel ple

      -

      Parameters

      • jsonPtr: string

      Returns string[]

    fromJSON

    executeDataChangeCallbacks

    from

    • from(jsonPtr): string[]

    • to preserve backward compatibility of the from command, the parallel ple

      +

      Parameters

      • jsonPtr: string

      Returns string[]

    fromJSON

    Private getDependenciesNode

    getInitializationPlan

    Private getDependenciesNode

    getInitializationPlan

    • getInitializationPlan(jsonPtr): ExecutionPlan

    • Generates an initialization plan for the specified JSON pointer.

      This method is typically queued by the TemplateProcessor during initialization. While the jsonPointer is often / (the root), it may point to a specific location in the template when $import is called to initialize an imported template.

      Parameters

      • jsonPtr: string

        The JSON pointer indicating the location for initialization.

      Returns ExecutionPlan

      The generated ExecutionPlan for initialization.

      -

    Private getInitializationPlanEntryPoints

    Private getInitializationPlanEntryPoints

    • getInitializationPlanEntryPoints(jsonPtr, options?): MetaInfo[]
    • Private

      Produces a list of MetaInfos that have no dependees and therefore are places to begin following dependencies from.

      -

      Parameters

      • jsonPtr: string
      • options: {
            exprsOnly?: boolean;
            jsonPtr?: string;
        } = ...
        • Optional exprsOnly?: boolean
        • Optional jsonPtr?: string

      Returns MetaInfo[]

    getMutationPlan

    • getMutationPlan(mutationTarget, data, op): [ExecutionPlan, string[]]

    • Generates a mutation plan for the specified JSON pointer and operation.

      +

      Parameters

      • jsonPtr: string
      • options: {
            exprsOnly?: boolean;
            jsonPtr?: string;
        } = ...
        • Optional exprsOnly?: boolean
        • Optional jsonPtr?: string

      Returns MetaInfo[]

    getMutationPlan

    • getMutationPlan(mutationTarget, data, op): [ExecutionPlan, string[]]

    • Generates a mutation plan for the specified JSON pointer and operation.

      This method creates a plan responsible for performing mutations on the template. Supported operations include initialize, set, delete, and forceSetInternal.

      @@ -56,5 +56,5 @@

    Returns [ExecutionPlan, string[]]

    [ExecutionPlan, JsonPointerString[]] The generated ExecutionPlan for the mutation and an array telling which expressions must be transitively re-evaluated as a result of the mutation.

    See

    Op

    -

    immediateAndImplicitDependencies

    • immediateAndImplicitDependencies(metaInfo, state): {
          newDependencies: string[];
          previouslyVisitedDependencies: string[];
      }

    • Parameters

      Returns {
          newDependencies: string[];
          previouslyVisitedDependencies: string[];
      }

      • newDependencies: string[]
      • previouslyVisitedDependencies: string[]

    Private logCircularDependency

    Private makeInitializationPlan

    Private markLeafMutation

    Private prune

    Private pruneFunction

    Private removeDegenerates

    restartIntervalsAndTimers

    restore

    Private restoreFunctions

    Private restoreIntervalsAndTimers

    • restoreIntervalsAndTimers(output, restarts): void

    • Parameters

      • output: any
      • restarts: string[]

      Returns void

    Private stepIsDescendantOfMutationTarget

    toJSON

    Private validatePlan

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    immediateAndImplicitDependencies

    Private logCircularDependency

    Private makeInitializationPlan

    Private markLeafMutation

    Private prune

    Private pruneFunction

    Private removeDegenerates

    restartIntervalsAndTimers

    restore

    Private restoreFunctions

    Private restoreIntervalsAndTimers

    Private stepIsDescendantOfMutationTarget

    toJSON

    Private validatePlan

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/SerialPlanner.SerialPlanner.html b/classes/SerialPlanner.SerialPlanner.html index 3f3901d6..f2db671a 100644 --- a/classes/SerialPlanner.SerialPlanner.html +++ b/classes/SerialPlanner.SerialPlanner.html @@ -9,7 +9,7 @@ forkStack:Fork[] //allows us to have nested execution contexts that cen restored by popping this stack onto output lastCompletedStep?:PlanStep, };

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    tp

    Methods

    applyMutationToFirstJsonPointerOfPlan evaluateRestorePlan @@ -26,30 +26,30 @@ topologicalSort isFunction isInterval -

    Constructors

    constructor

    Properties

    Private tp

    tp: default

    Methods

    applyMutationToFirstJsonPointerOfPlan

    evaluateRestorePlan

    • evaluateRestorePlan(plan): Promise<void>

    • This method is used to compile and evaluate function expressions and their dependencies.

      +

    Constructors

    constructor

    Properties

    Private tp

    tp: default

    Methods

    applyMutationToFirstJsonPointerOfPlan

    evaluateRestorePlan

    • evaluateRestorePlan(plan): Promise<void>

    • This method is used to compile and evaluate function expressions and their dependencies.

      Based on the metadata, we should identify all functions, and their dependencies

      -

      Parameters

      Returns Promise<void>

    execute

    execute

    • execute(plan): Promise<void>

    • Executes the specified execution plan.

      This method runs any plan that the Planner has generated, applying its operations to the template or its components.

      Parameters

      Returns Promise<void>

      A promise that resolves once execution is complete.

      -

    executeDataChangeCallbacks

    executeDependentExpressions

    from

    executeDataChangeCallbacks

    executeDependentExpressions

    from

    • from(jsonPtr): string[]

    • Returns a 'total ordering' of the dependency graph. A single array of JSON pointers is returned. From always uses the SerialPlanner therefore the returned array of json pointers should only be literally interpreted as the execution plan order when you are using a SerialPlanner. However, the point of from() is to give users of the command line a concise report on which parts of the output the dag will propagate to. In other words, the 'effects' that flow downstream from a mutation applied to jsonPtr

      Parameters

      • jsonPtr: string

      Returns string[]

      JsonPointerString[]

      -

    fromJSON

    fromJSON

    • fromJSON(planData, snapshot, forks): ExecutionPlan

    • This is the inverse of the toJSON. It takes a serializable execution plan and returns an object that can be used in the runtime.The snapshot is necessary because it contains normalization structures that have to be used to rehydrate an ExecutionPlan from a SerializableExecutionPlan

      -

      Parameters

      Returns ExecutionPlan

    getDependeesBFS

    getInitializationPlan

    getDependeesBFS

    getInitializationPlan

    • getInitializationPlan(jsonPointer?): ExecutionPlan

    • Generates an initialization plan for the specified JSON pointer.

      This method is typically queued by the TemplateProcessor during initialization. While the jsonPointer is often / (the root), it may point to a specific location in the template when $import is called to initialize an imported template.

      Parameters

      • jsonPointer: string = "/"

        The JSON pointer indicating the location for initialization.

      Returns ExecutionPlan

      The generated ExecutionPlan for initialization.

      -

    getMutationPlan

    getMutationPlan

    • getMutationPlan(jsonPtr, data, op): [SerialPlan, string[]]

    • Generates a mutation plan for the specified JSON pointer and operation.

      This method creates a plan responsible for performing mutations on the template. Supported operations include initialize, set, delete, and forceSetInternal.

      @@ -58,7 +58,7 @@

    Returns [SerialPlan, string[]]

    [ExecutionPlan, JsonPointerString[]] The generated ExecutionPlan for the mutation and an array telling which expressions must be transitively re-evaluated as a result of the mutation.

    See

    Op

    -

    Private restoreIntervalsExpressionsAndFunctions

    • restoreIntervalsExpressionsAndFunctions(plan): Promise<void>

    • Create an initialization plan from the execution plan, that intializes outputs that cannot be serialized and +

    Private restoreIntervalsExpressionsAndFunctions

    • restoreIntervalsExpressionsAndFunctions(plan): Promise<void>

    • Create an initialization plan from the execution plan, that intializes outputs that cannot be serialized and deserialized from the snapshot, such as timers, and functions.

      -

      Parameters

      Returns Promise<void>

    toJSON

    topologicalSort

    • topologicalSort(metaInfos, exprsOnly?, fanout?, extraOpts?): string[]

    • Parameters

      • metaInfos: MetaInfo[]
      • exprsOnly: boolean = true
      • fanout: boolean = true
      • extraOpts: {
            isFollowDependencies: boolean;
        } = ...
        • isFollowDependencies: boolean

      Returns string[]

    Static isFunction

    Static isInterval

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    toJSON

    topologicalSort

    Static isFunction

    Static isInterval

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/StatedREPL.default.html b/classes/StatedREPL.default.html index 2ed7246d..a756c3b2 100644 --- a/classes/StatedREPL.default.html +++ b/classes/StatedREPL.default.html @@ -1,4 +1,4 @@ -default | stated-js

    Class default

    Constructors

    constructor +default | stated-js

    Class default

    Constructors

    constructor

    Properties

    cliCore isColorized replServer @@ -9,4 +9,4 @@ registerCommands tookOverIO colorize -

    Constructors

    constructor

    Properties

    Private Readonly cliCore

    cliCore: default

    Private isColorized

    isColorized: boolean = false

    replServer

    replServer: REPLServer

    Static CLICORE_COMMANDS

    CLICORE_COMMANDS: string[][] = ...

    Methods

    cli

    • cli(cliCoreMethodName, args): Promise<boolean>

    • Parameters

      • cliCoreMethodName: string
      • args: string

      Returns Promise<boolean>

    close

    initialize

    registerCommands

    Private tookOverIO

    • tookOverIO(methodName, result): any

    • Parameters

      • methodName: string
      • result: any

      Returns any

    Static colorize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly cliCore

    cliCore: default

    Private isColorized

    isColorized: boolean = false

    replServer

    replServer: REPLServer

    Static CLICORE_COMMANDS

    CLICORE_COMMANDS: string[][] = ...

    Methods

    cli

    • cli(cliCoreMethodName, args): Promise<boolean>

    • Parameters

      • cliCoreMethodName: string
      • args: string

      Returns Promise<boolean>

    close

    initialize

    registerCommands

    Private tookOverIO

    • tookOverIO(methodName, result): any

    • Parameters

      • methodName: string
      • result: any

      Returns any

    Static colorize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/TemplateProcessor.default.html b/classes/TemplateProcessor.default.html index 0b9d73c3..d53d61df 100644 --- a/classes/TemplateProcessor.default.html +++ b/classes/TemplateProcessor.default.html @@ -10,7 +10,7 @@

    Example: Parse template from JSON or YAML

    Example: React to changes using data change callbacks on various locations in the template

     test("test 1", async () => {
        const tp = new TemplateProcessor({
            "a": "aaa",
            "b": "${a}"
        });
        await tp.initialize();
        const received = [];
        tp.setDataChangeCallback("/a", (data, jsonPtr) => {
            received.push({data, jsonPtr})
        });
        tp.setDataChangeCallback("/b", (data, jsonPtr) => {
            received.push({data, jsonPtr})
        });
        tp.setDataChangeCallback("/", (data, jsonPtr) => {
            received.push({data, jsonPtr})
        });
        await tp.setData("/a", 42);
        expect(received).toEqual([
            {
                "data": 42,
                "jsonPtr": "/a"
            },
            {
                "data": 42,
                "jsonPtr": "/b"
            },
            {
                "data": {
                    "a": 42,
                    "b": 42
                },
                "jsonPtr": [
                    "/a",
                    "/b"
                ]
            }
        ]);
    });
    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    changeCallbacks context debugger @@ -118,14 +118,14 @@

    Example: React to changes using data change callbacks on various locations i load simpleUniqueId wrapInOrdinaryFunction -

    Constructors

    constructor

    Properties

    Private changeCallbacks

    changeCallbacks: Map<string, Set<DataChangeCallback>>

    for every json pointer, we have multiple callbacks that are stored in a Set

    -

    context

    context: any

    Contextual data for the template processing.

    -

    debugger

    debugger: any

    Debugger utility for the template processor.

    -

    errorReport

    errorReport: {
        [key: JsonPointerString]: any;
    } = {}

    Contains any errors encountered during template processing.

    -

    Type declaration

    Private executionPlans

    executionPlans: {
        [key: JsonPointerString]: JsonPointerString[];
    } = {}

    Execution plans 'from' a given JSON Pointer. So key is JSON Pointer and value is array of JSON +

    Constructors

    constructor

    Properties

    Private changeCallbacks

    changeCallbacks: Map<string, Set<DataChangeCallback>>

    for every json pointer, we have multiple callbacks that are stored in a Set

    +

    context

    context: any

    Contextual data for the template processing.

    +

    debugger

    debugger: any

    Debugger utility for the template processor.

    +

    errorReport

    errorReport: {
        [key: JsonPointerString]: any;
    } = {}

    Contains any errors encountered during template processing.

    +

    Type declaration

    Private executionPlans

    executionPlans: {
        [key: JsonPointerString]: JsonPointerString[];
    } = {}

    Execution plans 'from' a given JSON Pointer. So key is JSON Pointer and value is array of JSON pointers (a plan)

    -

    Type declaration

    Private Readonly executionQueue

    executionQueue: (ExecutionPlan | SerialPlan | SnapshotPlan | Transaction)[] = []

    A queue of execution plans awaiting processing.

    -

    executionStatus

    executionStatus: ExecutionStatus

    functionGenerators

    functionGenerators: Map<string, FunctionGenerator<MetaInfo>> = ...

    function generators can be provided by a caller when functions need to be +

    Type declaration

    Private Readonly executionQueue

    executionQueue: (ExecutionPlan | SerialPlan | SnapshotPlan | Transaction)[] = []

    A queue of execution plans awaiting processing.

    +

    executionStatus

    executionStatus: ExecutionStatus

    functionGenerators

    functionGenerators: Map<string, FunctionGenerator<MetaInfo>> = ...

    function generators can be provided by a caller when functions need to be created in such a way that they are somehow 'responsive' or dependent on their location inside the template. Both the generator function, and the function it generates are asynchronous functions (ie they return a promise). @@ -134,21 +134,21 @@

    Example: React to changes using data change callbacks on various locations i is actually generated on the fly, using knowledge of the json path that it was called at, to replace the content of the template at that path with the downloaded content.

    -

    Private generatorManager

    generatorManager: GeneratorManager

    input

    input: any

    Represents the raw input for the template processor.

    -

    isClosed

    isClosed: boolean = false

    Private isInitializing

    isInitializing: boolean

    Flag indicating if the template processor is currently initializing.

    -

    Readonly lifecycleManager

    lifecycleManager: LifecycleOwner = ...

    logger

    logger: StatedLogger

    Represents the logger used within the template processor.

    -

    metaInfoByJsonPointer

    metaInfoByJsonPointer: MetaInfoMap = {}

    Maps JSON pointers of import paths to their associated meta information. +

    Private generatorManager

    generatorManager: GeneratorManager

    input

    input: any

    Represents the raw input for the template processor.

    +

    isClosed

    isClosed: boolean = false

    Private isInitializing

    isInitializing: boolean

    Flag indicating if the template processor is currently initializing.

    +

    Readonly lifecycleManager

    lifecycleManager: LifecycleOwner = ...

    logger

    logger: StatedLogger

    Represents the logger used within the template processor.

    +

    metaInfoByJsonPointer

    metaInfoByJsonPointer: MetaInfoMap = {}

    Maps JSON pointers of import paths to their associated meta information. So, for example the key "/" -> MetaInfo[]. the MetaInfo are in no particular order HOWEVER the individual MetaInfo objects are the same objects as memory as those in the templateMeta tree. Therefore, from any MetaInfo, you can navigate to it children as its children are simply field of the object that don't end in "". This explains why we name the MetaInfo fields with "" suffix, so they can be differentiated from 'real' fields of the template output nodes.

    -

    Readonly onInitialize

    onInitialize: Map<string, (() => void | Promise<void>)>

    Allows caller to set a callback to propagate initialization into their framework

    +

    Readonly onInitialize

    onInitialize: Map<string, (() => void | Promise<void>)>

    Allows caller to set a callback to propagate initialization into their framework

    Type declaration

      • (): void | Promise<void>

      • Returns void | Promise<void>

    Deprecated

    use lifecycleManager instead

    -

    options

    options: any = {}

    Configuration options for the template processor.

    -

    output

    output: {} = {}

    Contains the processed output after template processing.

    -

    Type declaration

      planStepFunctionGenerators

      planStepFunctionGenerators: Map<string, FunctionGenerator<PlanStep>> = ...

      planner

      planner: Planner

      An instance of the Planner interface used to manage execution plans.

      +

      options

      options: any = {}

      Configuration options for the template processor.

      +

      output

      output: {} = {}

      Contains the processed output after template processing.

      +

      Type declaration

        planStepFunctionGenerators

        planStepFunctionGenerators: Map<string, FunctionGenerator<PlanStep>> = ...

        planner

        planner: Planner

        An instance of the Planner interface used to manage execution plans.

        The planner is responsible for generating and executing ExecutionPlans, which define the steps necessary to process templates. It provides methods to initialize plans based on metadata and execute those plans. The planner @@ -157,18 +157,18 @@

        Example: React to changes using data change callbacks on various locations i
      • Planner
      • ExecutionPlan
        • -

        postInitialize

        postInitialize: (() => Promise<void>) = ...

        Allows a caller to receive a callback after the template is evaluated, but before any temporary variables are +

        postInitialize

        postInitialize: (() => Promise<void>) = ...

        Allows a caller to receive a callback after the template is evaluated, but before any temporary variables are removed. This function is slated to be replaced with a map of functions like onInitialize

        Type declaration

          • (): Promise<void>

          • Allows a caller to receive a callback after the template is evaluated, but before any temporary variables are removed. This function is slated to be replaced with a map of functions like onInitialize

            Returns Promise<void>

            Deprecated

            use lifecycleManager instead

        Deprecated

        use lifecycleManager instead

        -

        tagSet

        tagSet: Set<string>

        A set of tags associated with the template.

        -

        Private tempVars

        tempVars: string[] = []

        templateMeta

        templateMeta: Record<string, MetaInfo> = {}

        This object mirrors the template output in structure but where the output contains actual data, +

        tagSet

        tagSet: Set<string>

        A set of tags associated with the template.

        +

        Private tempVars

        tempVars: string[] = []

        templateMeta

        templateMeta: Record<string, MetaInfo> = {}

        This object mirrors the template output in structure but where the output contains actual data, this object contains MetaInfo nodes that track metadata on the actual nodes

        -

        timerManager

        timerManager: TimerManager

        uniqueId

        uniqueId: string

        A unique string identifier for the template processor instance like '3b12f1df-5232-4e1f-9c1b-3c6fc5ac7d3f'.

        -

        warnings

        warnings: any[] = []

        List of warnings generated during template processing.

        -

        Static DEFAULT_FUNCTIONS

        DEFAULT_FUNCTIONS: {
            Date: DateConstructor;
            console: Console;
            debounce: (<T>(func, wait?) => T);
            env: ((variableName, defaultValue?) => string);
            fetch: ((url, opts?) => Promise<Response>);
            rateLimit: (<T>(func, maxWait?) => T);
        } = ...

        Default set of functions provided for the template processor.

        +

        timerManager

        timerManager: TimerManager

        uniqueId

        uniqueId: string

        A unique string identifier for the template processor instance like '3b12f1df-5232-4e1f-9c1b-3c6fc5ac7d3f'.

        +

        warnings

        warnings: any[] = []

        List of warnings generated during template processing.

        +

        Static DEFAULT_FUNCTIONS

        DEFAULT_FUNCTIONS: {
            Date: DateConstructor;
            console: Console;
            debounce: (<T>(func, wait?) => T);
            env: ((variableName, defaultValue?) => string);
            fetch: ((url, opts?) => Promise<Response>);
            rateLimit: (<T>(func, maxWait?) => T);
        } = ...

        Default set of functions provided for the template processor.

        Type declaration

        • Date: DateConstructor
        • console: Console
        • debounce: (<T>(func, wait?) => T)
            • <T>(func, wait?): T

            • Debounces a function, ensuring that it is only called once after a specified time has elapsed since the last call.

              Type Parameters

              • T extends AnyFunction

              Parameters

              • func: T

                The function to debounce.

                @@ -189,14 +189,14 @@

                Example: React to changes using data change callbacks on various locations i

          • rateLimit: (<T>(func, maxWait?) => T)
              • <T>(func, maxWait?): T

              • Type Parameters

                • T extends AnyFunction

                Parameters

                • func: T
                • maxWait: number = 1000

                Returns T

        Remarks

        These functions are commonly used utilities available for usage within the template processor's context. You can replace set this to determine which functions are available from templates

        -

        Static

        Static NOOP

        NOOP: symbol = ...

        Static Private _isNodeJS

        _isNodeJS: boolean = ...

        Methods

        Private _evaluateExprNode

        Private _evaluateExpression

        Private _setData

        Private _strictChecks

        Private adjustRootForSimpleExpressionImports

        • adjustRootForSimpleExpressionImports(template, rootJsonPtr): any[]
        • Private

          Sometimes we need to import a simple expression string that is not nested in an object. +

          Static

        Static NOOP

        NOOP: symbol = ...

        Static Private _isNodeJS

        _isNodeJS: boolean = ...

        Methods

        Private _evaluateExprNode

        Private _evaluateExpression

        Private _setData

        Private _strictChecks

        Private adjustRootForSimpleExpressionImports

        • adjustRootForSimpleExpressionImports(template, rootJsonPtr): any[]
        • Private

          Sometimes we need to import a simple expression string that is not nested in an object. for example if we {"msg":"$import('${'hello ' & to }')"), then we are importing an expression directly into the parent, not nesting in an object. In this case we must slice off the last element of the rootJsonPointer, because to not slice it off would imply that the target of the expression is inside the msg field, but the intention when we import a simple expression is target the parent object which holds the msg field.

          Parameters

          • template: any
          • rootJsonPtr: any[]

          Returns any[]

          either the original rootJsonPointer, or one that has been trimmed to point to the parent of rootJsonPtr

          -

        Private allTagsPresent

        Private applyTransaction

        • applyTransaction(transaction): Promise<void>
        • Private

          Applies a transaction by processing each mutation within the transaction.

          +

        Private allTagsPresent

        Private applyTransaction

        • applyTransaction(transaction): Promise<void>
        • Private

          Applies a transaction by processing each mutation within the transaction.

          For each mutation, this method applies the specified operation (set or delete) to the output object based on the jsonPtr (JSON pointer). It also triggers data change callbacks after each mutation.

          @@ -209,21 +209,21 @@

          Static

        Private cacheTmpVarLocations

        callDataChangeCallbacks

        • callDataChangeCallbacks(data, jsonPointer, removed?, op?): Promise<void>

        • Parameters

          • data: any
          • jsonPointer: string | string[]
          • removed: boolean = false
          • op: Op = "set"

          Returns Promise<void>

        close

        Private compileMetaInfo

        Private createMetaInfos

        Private drainExecutionQueue

        • drainExecutionQueue(removeTmpVars?): Promise<void>

        • Parameters

          • removeTmpVars: boolean = true

          Returns Promise<void>

        evaluateNode

        executePlan

        Private extractFragmentIfNeeded

        Private fetchFromURL

        flow

        Private cacheTmpVarLocations

        callDataChangeCallbacks

        • callDataChangeCallbacks(data, jsonPointer, removed?, op?): Promise<void>

        • Parameters

          • data: any
          • jsonPointer: string | string[]
          • removed: boolean = false
          • op: Op = "set"

          Returns Promise<void>

        close

        Private compileMetaInfo

        Private createMetaInfos

        Private drainExecutionQueue

        • drainExecutionQueue(removeTmpVars?): Promise<void>

        • Parameters

          • removeTmpVars: boolean = true

          Returns Promise<void>

        evaluateNode

        executePlan

        Private extractFragmentIfNeeded

        Private fetchFromURL

        flow

        • flow(level): DataFlowNode[]

        • Controls the flow of data and retrieves root nodes based on the specified level.

          Parameters

          • level: FlowOpt

            The level specifying the granularity of the data flow.

          Returns DataFlowNode[]

          An array of root nodes that are computed based on the specified level.

          -

        from

        Private generateDeferFunction

        • generateDeferFunction(metaInfo): ((jsonPointer, timeoutMs) => object)

        • Parameters

          Returns ((jsonPointer, timeoutMs) => object)

            • (jsonPointer, timeoutMs): object

            • Parameters

              • jsonPointer: string
              • timeoutMs: number

              Returns object

        Private generateErrorReportFunction

        Private generateForked

        • generateForked(planStep): ((jsonPtr, data, op?) => Promise<void>)
        • Private

          When $forked is called, it must push the current output onto the forkStack so it can be restored on +

        from

        Private generateDeferFunction

        • generateDeferFunction(metaInfo): ((jsonPointer, timeoutMs) => object)

        • Parameters

          Returns ((jsonPointer, timeoutMs) => object)

            • (jsonPointer, timeoutMs): object

            • Parameters

              • jsonPointer: string
              • timeoutMs: number

              Returns object

        Private generateErrorReportFunction

        Private generateForked

        • generateForked(planStep): ((jsonPtr, data, op?) => Promise<void>)
        • Private

          When $forked is called, it must push the current output onto the forkStack so it can be restored on $joined, and it must replace the output with a copy of the output.

          -

          Parameters

          Returns ((jsonPtr, data, op?) => Promise<void>)

            • (jsonPtr, data, op?): Promise<void>

            • Parameters

              • jsonPtr: string
              • data: any
              • op: Op = 'set'

              Returns Promise<void>

        Private generateJoined

        • generateJoined(planStep): ((jsonPtr, data, op?) => Promise<void>)
        • Private

          The $joined(/foo, data) function pops the forkstack and can return us to ordinary +

          Parameters

          Returns ((jsonPtr, data, op?) => Promise<void>)

            • (jsonPtr, data, op?): Promise<void>

            • Parameters

              • jsonPtr: string
              • data: any
              • op: Op = 'set'

              Returns Promise<void>

        Private generateJoined

        • generateJoined(planStep): ((jsonPtr, data, op?) => Promise<void>)
        • Private

          The $joined(/foo, data) function pops the forkstack and can return us to ordinary non-forked operation if the pop operation empties the fork stack

          -

          Parameters

          Returns ((jsonPtr, data, op?) => Promise<void>)

            • (jsonPtr, data, op?): Promise<void>

            • Parameters

              • jsonPtr: string
              • data: any
              • op: Op = 'set'

              Returns Promise<void>

        Private generateSet

        • generateSet(planStep): ((jsonPtr, data?, op?) => Promise<string[]>) | ((jsonPtr, data, op?) => Promise<void>)
        • Private

          The $set(/foo, data) command may be operating inside the context of a $forked. If this is the case +

          Parameters

          Returns ((jsonPtr, data, op?) => Promise<void>)

            • (jsonPtr, data, op?): Promise<void>

            • Parameters

              • jsonPtr: string
              • data: any
              • op: Op = 'set'

              Returns Promise<void>

        Private generateSet

        • generateSet(planStep): ((jsonPtr, data?, op?) => Promise<string[]>) | ((jsonPtr, data, op?) => Promise<void>)
        • Private

          The $set(/foo, data) command may be operating inside the context of a $forked. If this is the case then $setData is intercepted here and we use the setDataForked function which applies changes to forked output

          -

          Parameters

          Returns ((jsonPtr, data?, op?) => Promise<string[]>) | ((jsonPtr, data, op?) => Promise<void>)

        getDependencies

        getDependents

        Private getImport

        • getImport(metaInfo): ((templateToImport, mergeMe?) => Promise<symbol>)

        • Parameters

          Returns ((templateToImport, mergeMe?) => Promise<symbol>)

            • (templateToImport, mergeMe?): Promise<symbol>

            • Parameters

              • templateToImport: string
              • Optional mergeMe: object

              Returns Promise<symbol>

        getMetaInfo

        • getMetaInfo(jsonPtr): MetaInfo

        • Retrieves the metadata information for a given JSON Pointer string.

          +

          Parameters

          Returns ((jsonPtr, data?, op?) => Promise<string[]>) | ((jsonPtr, data, op?) => Promise<void>)

        getDependencies

        getDependents

        Private getImport

        • getImport(metaInfo): ((templateToImport, mergeMe?) => Promise<symbol>)

        • Parameters

          Returns ((templateToImport, mergeMe?) => Promise<symbol>)

            • (templateToImport, mergeMe?): Promise<symbol>

            • Parameters

              • templateToImport: string
              • Optional mergeMe: object

              Returns Promise<symbol>

        getMetaInfo

        • getMetaInfo(jsonPtr): MetaInfo

        • Retrieves the metadata information for a given JSON Pointer string.

          Parameters

          • jsonPtr: string

            The JSON Pointer string that identifies the template node.

          Returns MetaInfo

          The MetaInfo object corresponding to the provided JSON Pointer.

          Throws

          If the JSON Pointer does not exist in the templateMeta.

          -

        import

        • import(template, jsonPtrImportPath): Promise<void>

        • Parameters

          • template: string | object
          • jsonPtrImportPath: string

          Returns Promise<void>

        initialize

        • initialize(importedSubtemplate?, jsonPtr?, executionStatusSnapshot?): Promise<void>

        • Template processor initialize can be called from 2 major use cases

          +

        import

        • import(template, jsonPtrImportPath): Promise<void>

        • Parameters

          • template: string | object
          • jsonPtrImportPath: string

          Returns Promise<void>

        initialize

        Private isEnabled

        Private isTempVarInScope

        • isTempVarInScope(metaInfo): boolean
        • Private

          temp vars are in scope if all tags are present OR the expression's fieldname ends in !, which makes +

        • executionStatusSnapshot: undefined | Snapshot = undefined

        Returns Promise<void>

        Private isEnabled

        Private isTempVarInScope

        • isTempVarInScope(metaInfo): boolean
        • Private

          temp vars are in scope if all tags are present OR the expression's fieldname ends in !, which makes it an absolutely temporary variable since.

          -

          Parameters

          Returns boolean

        Private localImport

        Private logOutput

        Private makeDepsAbsolute

        mutate

        out

        Private parseURL

        plan

        Private populateContextWithGeneratedFunctions

        • populateContextWithGeneratedFunctions(context, functionNames, metaInf, planStep): Promise<void>
        • Private

          Certain functions callable in a JSONata expression must be dynamically generated. They cannot be static +

          Parameters

          Returns boolean

        Private localImport

        Private logOutput

        Private makeDepsAbsolute

        mutate

        out

        Private parseURL

        plan

        Private populateContextWithGeneratedFunctions

        • populateContextWithGeneratedFunctions(context, functionNames, metaInf, planStep): Promise<void>
        • Private

          Certain functions callable in a JSONata expression must be dynamically generated. They cannot be static generated because the function instance needs to hold a reference to some kind of runtime state, either a MetaInfo or a PlanStep (see FunctionGenerator type). This method, for a given list of function names, generates the function by finding and calling the corresponding FunctionGenerator.

          -

          Parameters

          Returns Promise<void>

        Private populateContextWithSelf

        Private populateTemplateMeta

        Private propagateTags

        Private queueInitializationPlan

        removeDataChangeCallback

        Private removeLeadingDollarsFromDependencies

        Private removeTemporaryVariables

        • removeTemporaryVariables(tmpVars, jsonPtrOfTemplate): void

        • Parameters

          • tmpVars: string[]
          • jsonPtrOfTemplate: string

          Returns void

        removeTransactionCallback

        • removeTransactionCallback(cb): void

        • Removes a previously registered transaction callback.

          +

          Parameters

          Returns Promise<void>

        Private populateContextWithSelf

        Private populateTemplateMeta

        Private propagateTags

        Private queueInitializationPlan

        removeDataChangeCallback

        Private removeLeadingDollarsFromDependencies

        Private removeTemporaryVariables

        • removeTemporaryVariables(tmpVars, jsonPtrOfTemplate): void

        • Parameters

          • tmpVars: string[]
          • jsonPtrOfTemplate: string

          Returns void

        removeTransactionCallback

        • removeTransactionCallback(cb): void

        • Removes a previously registered transaction callback.

          This method removes the callback that was registered with setTransactionCallback for the root path '/'.

          Parameters

          • cb: DataChangeCallback

            The callback function to remove, which should match the previously registered callback.

            -

          Returns void

        Private resetTemplate

        restore

        restoreFromSnapshotObject

        Private restoreFunctions

        Private setContentInTemplate

        • setContentInTemplate(literalTemplateToImport, metaInfo): Promise<void>

        • Parameters

          • literalTemplateToImport: any
          • metaInfo: MetaInfo

          Returns Promise<void>

        setData

        • setData(jsonPtr, data?, op?): Promise<string[]>

        • Sets or deletes data based on the specified operation.

          +

        Returns void

        Private resetTemplate

        restore

        restoreFromSnapshotObject

        Private restoreFunctions

        Private setContentInTemplate

        • setContentInTemplate(literalTemplateToImport, metaInfo): Promise<void>

        • Parameters

          • literalTemplateToImport: any
          • metaInfo: MetaInfo

          Returns Promise<void>

        setData

        • setData(jsonPtr, data?, op?): Promise<string[]>

        • Sets or deletes data based on the specified operation.

          Parameters

          • jsonPtr: string

            The JSON pointer indicating where to apply the operation.

          • Optional data: any = null

            The data to be used with the set or setDeferred operation.

          • Optional op: Op = "set"

            The operation to perform - setDeferred is for internal use

          Returns Promise<string[]>

          A promise with the list of json pointers touched by the plan

          -

          Async

        setDataChangeCallback

        • setDataChangeCallback(jsonPtr, cbFn): void

        • Sets a data change callback function that will be called whenever the value at the json pointer has changed

          +

          Async

        setDataChangeCallback

        • setDataChangeCallback(jsonPtr, cbFn): void

        • Sets a data change callback function that will be called whenever the value at the json pointer has changed

          Parameters

          • jsonPtr: string
          • cbFn: DataChangeCallback

            of form (data, ptr:JsonPointerString, removed?:boolean)=>void

            -

          Returns void

        setDataForked

        • setDataForked(forkedPlanStep): Promise<string[]>

        • Calling setDataForked allows the mutation and its reaction (fromPlan) to begin executing immediately without +

        Returns void

        setDataForked

        • setDataForked(forkedPlanStep): Promise<string[]>

        • Calling setDataForked allows the mutation and its reaction (fromPlan) to begin executing immediately without queuing/seriealizing/blocking on other plans. This is possible because a forked planStep contains a write-safe copy of this.output (essentially a 'snapshot' in MVCC terminology) and therefore the mutation and propagation of the fromPlan are isolated, just like snapshot isolation levels on Postres or other MVCC databases. So, do not await this method. Just let 'er rip.

          -

          Parameters

          Returns Promise<string[]>

        Private setDataIntoTrackedLocation

        setExpression

        • setExpression(expression, jsonPointer): Promise<void>

        • allows direct injection of ${expression} into template at given jsonPointer.

          -

          Parameters

          • expression: string
          • jsonPointer: string

          Returns Promise<void>

        setTransactionCallback

        • setTransactionCallback(cb): void

        • Registers a transaction callback to handle batched data changes.

          +

          Parameters

          Returns Promise<string[]>

        Private setDataIntoTrackedLocation

        setExpression

        • setExpression(expression, jsonPointer): Promise<void>

        • allows direct injection of ${expression} into template at given jsonPointer.

          +

          Parameters

          • expression: string
          • jsonPointer: string

          Returns Promise<void>

        setTransactionCallback

        Private setUntrackedLocation

        setupContext

        Private setupDependees

        Private setupFunctionGenerators

        snapshot

        • snapshot(): Promise<string>

        • Creates a stringified snapshot of the current state of the TemplateProcessor instance, +

        Private setUntrackedLocation

        setupContext

        Private setupDependees

        Private setupFunctionGenerators

        snapshot

        • snapshot(): Promise<string>

        • Creates a stringified snapshot of the current state of the TemplateProcessor instance, including its execution status, input, output, and options.

          Returns Promise<string>

          A JSON string representing the snapshot of the TemplateProcessor's current state, including template input, processed output, and options.

          Example

          const tp = new TemplateProcessor(template, context, options);
          const snapshotString = await tp.snapshot();
          // snapshotString contains a JSON string with the execution plans, mvcc, template, output, and options of the
          TemplateProcessor
          -

        Private sortMetaInfos

        to

        Private validateAsJSON

        Private withErrorHandling

        • withErrorHandling<T>(fn): ((...args) => any)

        • Type Parameters

          • T extends any[]

          Parameters

          • fn: ((...args) => any)
              • (...args): any

              • Parameters

                • Rest ...args: T

                Returns any

          Returns ((...args) => any)

            • (...args): any

            • Parameters

              • Rest ...args: T

              Returns any

        Static Private compileToJsonPointer

        Static constructFromSnapshotObject

        • constructFromSnapshotObject(snapshot, context?): default

        • Constructs a new TemplateProcessor instance from a given snapshot object, but does NOT initialize it. +

        Private sortMetaInfos

        to

        Private validateAsJSON

        Private withErrorHandling

        • withErrorHandling<T>(fn): ((...args) => any)

        • Type Parameters

          • T extends any[]

          Parameters

          • fn: ((...args) => any)
              • (...args): any

              • Parameters

                • Rest ...args: T

                Returns any

          Returns ((...args) => any)

            • (...args): any

            • Parameters

              • Rest ...args: T

              Returns any

        Static Private compileToJsonPointer

        Static constructFromSnapshotObject

        • constructFromSnapshotObject(snapshot, context?): default

        • Constructs a new TemplateProcessor instance from a given snapshot object, but does NOT initialize it. This method allows the caller the opportunity to register dataChangeCallbacks and so forth before template evaluation begins, providing more control over the initialization process.

          Parameters

          • snapshot: Snapshot

            A snapshot object containing template, options, and output data for initializing the TemplateProcessor.

            @@ -277,10 +277,10 @@

            Static

          Returns default

          A new TemplateProcessor instance constructed from the snapshot data, not yet initialized.

          Example

          const snapshot = {"template":"...", "options":{}, "output":"..."};
          const tp = TemplateProcessor.constructFromSnapshot(snapshot);
          // Register callbacks or perform other setup operations here
          await tp.initialize();
          -

          Static Private deepCopy

          • deepCopy(output): any

          • this function is used to make a deep copy of the output so that when we $fork we are operating +

          Static Private deepCopy

          • deepCopy(output): any

          • this function is used to make a deep copy of the output so that when we $fork we are operating on a copy of the output, not co-mutating the original

            -

            Parameters

            • output: object

            Returns any

          Static Private dependsOnImportedTemplate

          Static fromSnapshot

          Static fromString

          Static load

          • load(template, context?, options?): Promise<default>

          • Loads a template and initializes a new template processor instance.

            +

            Parameters

            • output: object

            Returns any

          Static Private dependsOnImportedTemplate

          Static fromSnapshot

          Static fromString

          Static load

          • load(template, context?, options?): Promise<default>

          • Loads a template and initializes a new template processor instance.

            Parameters

            • template: object

              The template data to be processed.

            • Optional context: {} = {}

              Optional context data for the template.

              • options: object = {}

              Returns Promise<default>

              Returns an initialized instance of TemplateProcessor.

              -

              Static

            Static simpleUniqueId

            Static wrapInOrdinaryFunction

            • wrapInOrdinaryFunction(jsonataLambda): {
                  _stated_function__: boolean;
                  apply(_this, args): any;
                  (...args): any;
              }

            • Parameters

              • jsonataLambda: any

              Returns {
                  _stated_function__: boolean;
                  apply(_this, args): any;
                  (...args): any;
              }

                • (...args): any

                • Parameters

                  • Rest ...args: any[]

                  Returns any

              • _stated_function__: boolean
              • apply:function

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Static

            Static simpleUniqueId

            Static wrapInOrdinaryFunction

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/classes/TimerManager.TimerManager.html b/classes/TimerManager.TimerManager.html index 4b04bba9..37ac7cd8 100644 --- a/classes/TimerManager.TimerManager.html +++ b/classes/TimerManager.TimerManager.html @@ -1,4 +1,4 @@ -TimerManager | stated-js

            Class TimerManager

            Constructors

            constructor +TimerManager | stated-js

            Class TimerManager

            Constructors

            constructor

            Properties

            intervals jsonPointerByInterval timeouts @@ -13,4 +13,4 @@ isInterval setInterval setTimeout -

            Constructors

            constructor

            Properties

            Private intervals

            intervals: Set<Timeout>

            Private jsonPointerByInterval

            jsonPointerByInterval: Map<Timeout, string>

            Private timeouts

            timeouts: Set<Timeout>

            Private tp

            tp: default

            Methods

            clear

            Private clearAllIntervals

            Private clearAllTimeouts

            clearInterval

            clearTimeout

            generateClearInterval

            • generateClearInterval(planStep): ((interval) => Promise<void>)

            • Parameters

              Returns ((interval) => Promise<void>)

                • (interval): Promise<void>

                • Parameters

                  • interval: Timeout

                  Returns Promise<void>

            generateSetInterval

            • generateSetInterval(planStep): ((callback, delay, ...args) => Timeout)

            • Parameters

              Returns ((callback, delay, ...args) => Timeout)

                • (callback, delay, ...args): Timeout

                • Parameters

                  • callback: ((...args) => void)
                      • (...args): void

                      • Parameters

                        • Rest ...args: any[]

                        Returns void

                  • delay: number
                  • Rest ...args: any[]

                  Returns Timeout

            isInterval

            setInterval

            • setInterval(callback, delay, ...args): Timeout

            • Parameters

              • callback: ((...args) => void)
                  • (...args): void

                  • Parameters

                    • Rest ...args: any[]

                    Returns void

              • delay: number
              • Rest ...args: any[]

              Returns Timeout

            setTimeout

            • setTimeout(callback, delay, ...args): Timeout

            • Parameters

              • callback: ((...args) => void)
                  • (...args): void

                  • Parameters

                    • Rest ...args: any[]

                    Returns void

              • delay: number
              • Rest ...args: any[]

              Returns Timeout

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Constructors

            constructor

            Properties

            Private intervals

            intervals: Set<Timeout>

            Private jsonPointerByInterval

            jsonPointerByInterval: Map<Timeout, string>

            Private timeouts

            timeouts: Set<Timeout>

            Private tp

            tp: default

            Methods

            clear

            Private clearAllIntervals

            Private clearAllTimeouts

            clearInterval

            clearTimeout

            generateClearInterval

            • generateClearInterval(planStep): ((interval) => Promise<void>)

            • Parameters

              Returns ((interval) => Promise<void>)

                • (interval): Promise<void>

                • Parameters

                  • interval: Timeout

                  Returns Promise<void>

            generateSetInterval

            • generateSetInterval(planStep): ((callback, delay, ...args) => Timeout)

            • Parameters

              Returns ((callback, delay, ...args) => Timeout)

                • (callback, delay, ...args): Timeout

                • Parameters

                  • callback: ((...args) => void)
                      • (...args): void

                      • Parameters

                        • Rest ...args: any[]

                        Returns void

                  • delay: number
                  • Rest ...args: any[]

                  Returns Timeout

            isInterval

            setInterval

            • setInterval(callback, delay, ...args): Timeout

            • Parameters

              • callback: ((...args) => void)
                  • (...args): void

                  • Parameters

                    • Rest ...args: any[]

                    Returns void

              • delay: number
              • Rest ...args: any[]

              Returns Timeout

            setTimeout

            • setTimeout(callback, delay, ...args): Timeout

            • Parameters

              • callback: ((...args) => void)
                  • (...args): void

                  • Parameters

                    • Rest ...args: any[]

                    Returns void

              • delay: number
              • Rest ...args: any[]

              Returns Timeout

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/classes/TraversalState.TraversalState.html b/classes/TraversalState.TraversalState.html index b0e57201..5731bebb 100644 --- a/classes/TraversalState.TraversalState.html +++ b/classes/TraversalState.TraversalState.html @@ -1,4 +1,4 @@ -TraversalState | stated-js

            Class TraversalState

            Constructors

            constructor +TraversalState | stated-js

            Class TraversalState

            Constructors

            constructor

            Properties

            options recursionStack stack @@ -9,9 +9,9 @@ logCircular popNode pushNode -

            Constructors

            constructor

            Properties

            options

            options: {
                exprsOnly: boolean;
            } = ...

            Type declaration

            • exprsOnly: boolean

            recursionStack

            recursionStack: Set<string> = ...

            stack

            stack: ParallelExecutionPlan[] = []

            tp

            tp: default

            visited

            visited: Set<unknown> = ...

            Methods

            isCircular

            • isCircular(dependency, owner): boolean

            • Parameters

              • dependency: string
              • owner: string

              Returns boolean

            Private isCommonPrefix

            • isCommonPrefix(exprNode, dependency): boolean

            • Used to detect a condition where like "data:${data.foo}" which essentially declares a dependency on the +

            Constructors

            constructor

            Properties

            options

            options: {
                exprsOnly: boolean;
            } = ...

            Type declaration

            • exprsOnly: boolean

            recursionStack

            recursionStack: Set<string> = ...

            stack

            stack: ParallelExecutionPlan[] = []

            tp

            tp: default

            visited

            visited: Set<unknown> = ...

            Methods

            isCircular

            • isCircular(dependency, owner): boolean

            • Parameters

              • dependency: string
              • owner: string

              Returns boolean

            Private isCommonPrefix

            • isCommonPrefix(exprNode, dependency): boolean

            • Used to detect a condition where like "data:${data.foo}" which essentially declares a dependency on the expression itself. This is inherently circular. You cannot say "use that thing in this expression, where that thing is a product of evaluating this expression". You also cannot say "use that thing in this expression where that thing is a direct ancestor of this expression" as that is also circular, implying that the expression tries to reference an ancestor node, whose descendent includes this very node.

              -

              Parameters

              • exprNode: string
              • dependency: string

              Returns boolean

            logCircular

            popNode

            pushNode

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Parameters

            Returns boolean

            logCircular

            popNode

            pushNode

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/classes/VizGraph.default.html b/classes/VizGraph.default.html index 523663fe..db71baef 100644 --- a/classes/VizGraph.default.html +++ b/classes/VizGraph.default.html @@ -1,4 +1,4 @@ -default | stated-js

            Class default

            Constructors

            constructor +default | stated-js

            Class default

            Constructors

            constructor

            Methods

            dot escapeSpecialCharacters -

            Constructors

            constructor

            Methods

            Static dot

            Static escapeSpecialCharacters

            • escapeSpecialCharacters(str): string

            • Parameters

              • str: undefined | null | string

              Returns string

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Constructors

            constructor

            Methods

            Static dot

            Static escapeSpecialCharacters

            • escapeSpecialCharacters(str): string

            • Parameters

              • str: undefined | null | string

              Returns string

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/enums/Lifecycle.LifecycleState.html b/enums/Lifecycle.LifecycleState.html index 5e58bddf..ea1371b7 100644 --- a/enums/Lifecycle.LifecycleState.html +++ b/enums/Lifecycle.LifecycleState.html @@ -1,13 +1,13 @@ LifecycleState | stated-js

            Enumeration LifecycleState

            Enum representing the various states of the lifecycle. This is used to track different phases during the operation of the system.

            -

            Enumeration Members

            Closed +

            Enumeration Members

            Closed Initialized PreTmpVarRemoval StartClose StartInitialize

            Enumeration Members

            Closed

            Closed: "Closed"

            The state when the system has fully closed and is no longer operational.

            -

            Initialized

            Initialized: "Initialized"

            The state when the system has been fully initialized and is ready for use.

            -

            PreTmpVarRemoval

            PreTmpVarRemoval: "PreTmpVarRemoval"

            The state before temporary variables are removed from the system.

            -

            StartClose

            StartClose: "StartClose"

            The state when the process to close the system begins.

            -

            StartInitialize

            StartInitialize: "StartInitialize"

            The state representing the start of the initialization process.

            -

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Initialized

            Initialized: "Initialized"

            The state when the system has been fully initialized and is ready for use.

            +

            PreTmpVarRemoval

            PreTmpVarRemoval: "PreTmpVarRemoval"

            The state before temporary variables are removed from the system.

            +

            StartClose

            StartClose: "StartClose"

            The state when the process to close the system begins.

            +

            StartInitialize

            StartInitialize: "StartInitialize"

            The state representing the start of the initialization process.

            +

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/functions/ParallelExecutionPlanDefault.isMutation.html b/functions/ParallelExecutionPlanDefault.isMutation.html index a94f6fa2..11a56e49 100644 --- a/functions/ParallelExecutionPlanDefault.isMutation.html +++ b/functions/ParallelExecutionPlanDefault.isMutation.html @@ -1 +1 @@ -isMutation | stated-js

            Function isMutation

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +isMutation | stated-js

            Function isMutation

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/functions/TestUtils.parseMarkdownAndTestCodeblocks.html b/functions/TestUtils.parseMarkdownAndTestCodeblocks.html index cc574019..bf77a549 100644 --- a/functions/TestUtils.parseMarkdownAndTestCodeblocks.html +++ b/functions/TestUtils.parseMarkdownAndTestCodeblocks.html @@ -1 +1 @@ -parseMarkdownAndTestCodeblocks | stated-js

            Function parseMarkdownAndTestCodeblocks

            • parseMarkdownAndTestCodeblocks(md, cliCore, printFunction?): Promise<void>

            • Parameters

              • md: string
              • cliCore: default
              • printFunction: ((k, v) => any) = stringifyTemplateJSON
                  • (k, v): any

                  • Parameters

                    • k: any
                    • v: any

                    Returns any

              Returns Promise<void>

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +parseMarkdownAndTestCodeblocks | stated-js

            Function parseMarkdownAndTestCodeblocks

            • parseMarkdownAndTestCodeblocks(md, cliCore, printFunction?): Promise<void>

            • Parameters

              • md: string
              • cliCore: default
              • printFunction: ((k, v) => any) = stringifyTemplateJSON
                  • (k, v): any

                  • Parameters

                    • k: any
                    • v: any

                    Returns any

              Returns Promise<void>

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/functions/TestUtils.parseMarkdownTests.html b/functions/TestUtils.parseMarkdownTests.html index b516cf9a..4eab89b7 100644 --- a/functions/TestUtils.parseMarkdownTests.html +++ b/functions/TestUtils.parseMarkdownTests.html @@ -2,4 +2,4 @@

            Parameters

            Returns CommandAndResponse[]

            Array of test data including commands and expected responses.

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/functions/index.stringifyTemplateJSON.html b/functions/index.stringifyTemplateJSON.html index 9c2b0372..63ab9555 100644 --- a/functions/index.stringifyTemplateJSON.html +++ b/functions/index.stringifyTemplateJSON.html @@ -1 +1 @@ -stringifyTemplateJSON | stated-js

            Function stringifyTemplateJSON

            • stringifyTemplateJSON(o, printFunction?): string

            • Parameters

              • o: any
              • printFunction: ((key, value) => any) = circularReplacer
                  • (key, value): any

                  • Parameters

                    • key: any
                    • value: any

                    Returns any

              Returns string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +stringifyTemplateJSON | stated-js

            Function stringifyTemplateJSON

            • stringifyTemplateJSON(o, printFunction?): string

            • Parameters

              • o: any
              • printFunction: ((key, value) => any) = circularReplacer
                  • (key, value): any

                  • Parameters

                    • key: any
                    • value: any

                    Returns any

              Returns string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/interfaces/ConsoleLogger.StatedLogger.html b/interfaces/ConsoleLogger.StatedLogger.html index 31dc1d93..9443ccff 100644 --- a/interfaces/ConsoleLogger.StatedLogger.html +++ b/interfaces/ConsoleLogger.StatedLogger.html @@ -1,8 +1,8 @@ -StatedLogger | stated-js

            Interface StatedLogger

            interface StatedLogger {
                level: Levels;
                debug(...args): void;
                error(...args): void;
                info(...args): void;
                log(level, ...args): void;
                verbose(...args): void;
                warn(...args): void;
            }

            Implemented by

            Properties

            level +StatedLogger | stated-js

            Interface StatedLogger

            interface StatedLogger {
                level: Levels;
                debug(...args): void;
                error(...args): void;
                info(...args): void;
                log(level, ...args): void;
                verbose(...args): void;
                warn(...args): void;
            }

            Implemented by

            Properties

            level

            Methods

            debug error info log verbose warn -

            Properties

            level

            level: Levels

            Methods

            debug

            error

            info

            log

            verbose

            warn

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Properties

            level

            level: Levels

            Methods

            debug

            error

            info

            log

            verbose

            warn

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/interfaces/Lifecycle.LifecycleOwner.html b/interfaces/Lifecycle.LifecycleOwner.html index 22a85b4a..3118e1b7 100644 --- a/interfaces/Lifecycle.LifecycleOwner.html +++ b/interfaces/Lifecycle.LifecycleOwner.html @@ -1,10 +1,10 @@ LifecycleOwner | stated-js

            Interface LifecycleOwner

            Interface for managing lifecycle callbacks.

            -
            interface LifecycleOwner {
                removeLifecycleCallback(state, cbFn?): void;
                setLifecycleCallback(state, cbFn): void;
            }

            Implemented by

            Methods

            removeLifecycleCallback +
            interface LifecycleOwner {
                removeLifecycleCallback(state, cbFn?): void;
                setLifecycleCallback(state, cbFn): void;
            }

            Implemented by

            Methods

            removeLifecycleCallback setLifecycleCallback

            Methods

            removeLifecycleCallback

            • removeLifecycleCallback(state, cbFn?): void

            • Removes a specific lifecycle callback or all callbacks for a lifecycle state.

              Parameters

              • state: LifecycleState

                The lifecycle state to remove the callback from.

              • Optional cbFn: LifecycleCallback

                The specific callback function to remove. If not provided, all callbacks for the state will be removed.

                -

              Returns void

            setLifecycleCallback

            • setLifecycleCallback(state, cbFn): void

            • Registers a lifecycle callback for a specific lifecycle state.

              +

            Returns void

            setLifecycleCallback

            • setLifecycleCallback(state, cbFn): void

            • Registers a lifecycle callback for a specific lifecycle state.

              Parameters

              • state: LifecycleState

                The lifecycle state to register the callback for.

              • cbFn: LifecycleCallback

                The callback function to execute when the lifecycle state is triggered.

                -

              Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/interfaces/MetaInfoProducer.MetaInfo.html b/interfaces/MetaInfoProducer.MetaInfo.html index cec3716c..4a7c422d 100644 --- a/interfaces/MetaInfoProducer.MetaInfo.html +++ b/interfaces/MetaInfoProducer.MetaInfo.html @@ -1,4 +1,4 @@ -MetaInfo | stated-js

            Interface MetaInfo

            interface MetaInfo {
                absoluteDependencies__: string[] | JsonPointerStructureArray[];
                compiledExpr__?: Expression;
                data__?: any;
                dependees__: string[] | JsonPointerStructureArray[];
                dependencies__: string[] | JsonPointerStructureArray[];
                exprRootPath__?: string;
                exprTargetJsonPointer__?: string | JsonPointerStructureArray;
                expr__?: string;
                isFunction__?: boolean;
                isInitialized__?: boolean;
                jsonPointer__: string | JsonPointerStructureArray;
                materialized__: boolean;
                parent__: string | JsonPointerStructureArray;
                tags__: string[];
                temp__?: boolean;
                treeHasExpressions__: boolean;
                variables__?: string[];
            }

            Properties

            absoluteDependencies__ +MetaInfo | stated-js

            Interface MetaInfo

            interface MetaInfo {
                absoluteDependencies__: string[] | JsonPointerStructureArray[];
                compiledExpr__?: Expression;
                data__?: any;
                dependees__: string[] | JsonPointerStructureArray[];
                dependencies__: string[] | JsonPointerStructureArray[];
                exprRootPath__?: string;
                exprTargetJsonPointer__?: string | JsonPointerStructureArray;
                expr__?: string;
                isFunction__?: boolean;
                isInitialized__?: boolean;
                jsonPointer__: string | JsonPointerStructureArray;
                materialized__: boolean;
                parent__: string | JsonPointerStructureArray;
                tags__: string[];
                temp__?: boolean;
                treeHasExpressions__: boolean;
                variables__?: string[];
            }

            Properties

            absoluteDependencies__ compiledExpr__? data__? dependees__ @@ -15,4 +15,4 @@ temp__? treeHasExpressions__ variables__? -

            Properties

            absoluteDependencies__

            absoluteDependencies__: string[] | JsonPointerStructureArray[]

            Optional compiledExpr__

            compiledExpr__?: Expression

            Optional data__

            data__?: any

            dependees__

            dependees__: string[] | JsonPointerStructureArray[]

            dependencies__

            dependencies__: string[] | JsonPointerStructureArray[]

            Optional exprRootPath__

            exprRootPath__?: string

            Optional exprTargetJsonPointer__

            exprTargetJsonPointer__?: string | JsonPointerStructureArray

            Optional expr__

            expr__?: string

            Optional isFunction__

            isFunction__?: boolean

            Optional isInitialized__

            isInitialized__?: boolean

            jsonPointer__

            jsonPointer__: string | JsonPointerStructureArray

            materialized__

            materialized__: boolean

            parent__

            parent__: string | JsonPointerStructureArray

            tags__

            tags__: string[]

            Optional temp__

            temp__?: boolean

            treeHasExpressions__

            treeHasExpressions__: boolean

            Optional variables__

            variables__?: string[]

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Properties

            absoluteDependencies__

            absoluteDependencies__: string[] | JsonPointerStructureArray[]

            Optional compiledExpr__

            compiledExpr__?: Expression

            Optional data__

            data__?: any

            dependees__

            dependees__: string[] | JsonPointerStructureArray[]

            dependencies__

            dependencies__: string[] | JsonPointerStructureArray[]

            Optional exprRootPath__

            exprRootPath__?: string

            Optional exprTargetJsonPointer__

            exprTargetJsonPointer__?: string | JsonPointerStructureArray

            Optional expr__

            expr__?: string

            Optional isFunction__

            isFunction__?: boolean

            Optional isInitialized__

            isInitialized__?: boolean

            jsonPointer__

            jsonPointer__: string | JsonPointerStructureArray

            materialized__

            materialized__: boolean

            parent__

            parent__: string | JsonPointerStructureArray

            tags__

            tags__: string[]

            Optional temp__

            temp__?: boolean

            treeHasExpressions__

            treeHasExpressions__: boolean

            Optional variables__

            variables__?: string[]

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/interfaces/ParallelExecutionPlan.ParallelExecutionPlan.html b/interfaces/ParallelExecutionPlan.ParallelExecutionPlan.html index b123ddcb..09d808b5 100644 --- a/interfaces/ParallelExecutionPlan.ParallelExecutionPlan.html +++ b/interfaces/ParallelExecutionPlan.ParallelExecutionPlan.html @@ -1,7 +1,7 @@ ParallelExecutionPlan | stated-js

            Interface ParallelExecutionPlan

            Represents a parallel execution plan that can be executed concurrently. This interface extends both ExecutionPlan and PlanStep to provide functionality for parallel processing of template operations.

            -
            interface ParallelExecutionPlan {
                completed: boolean;
                data?: any;
                didUpdate: boolean;
                forkId: string;
                forkStack: Fork[];
                jsonPtr: string;
                lastCompletedStep?: PlanStep;
                op?: Op;
                output: object;
                parallel: ParallelExecutionPlan[];
                restore?: boolean;
                type?: "serial|parallel";
            }

            Hierarchy (view full)

            Implemented by

            Properties

            completed +
            interface ParallelExecutionPlan {
                completed: boolean;
                data?: any;
                didUpdate: boolean;
                forkId: string;
                forkStack: Fork[];
                jsonPtr: string;
                lastCompletedStep?: PlanStep;
                op?: Op;
                output: object;
                parallel: ParallelExecutionPlan[];
                restore?: boolean;
                type?: "serial|parallel";
            }

            Hierarchy (view full)

            Implemented by

            Properties

            completed data? didUpdate forkId @@ -15,21 +15,21 @@ type?

            Properties

            completed

            completed: boolean

            Indicates whether the entire execution subtree rooted at this node has finished processing. When true, all child nodes in the parallel array have also completed their execution.

            -

            Optional data

            data?: any

            The data associated with the plan. May be undefined for initialization plans.

            -

            didUpdate

            didUpdate: boolean

            forkId

            forkId: string

            The identifier for the fork associated with this execution plan. Will be "ROOT" when the plan is not +

            Optional data

            data?: any

            The data associated with the plan. May be undefined for initialization plans.

            +

            didUpdate

            didUpdate: boolean

            forkId

            forkId: string

            The identifier for the fork associated with this execution plan. Will be "ROOT" when the plan is not executing a fork

            -

            forkStack

            forkStack: Fork[]

            The stack of forks involved in this execution plan. Forks will push and pop on top of the ROOT fork +

            forkStack

            forkStack: Fork[]

            The stack of forks involved in this execution plan. Forks will push and pop on top of the ROOT fork corresponding to entering a $forked() and exiting a forked plan on $joined()

            -

            jsonPtr

            jsonPtr: string

            A JSON Pointer string that identifies the location in the template being processed. +

            jsonPtr

            jsonPtr: string

            A JSON Pointer string that identifies the location in the template being processed. This pointer is used to track and reference specific nodes in the template structure.

            -

            Optional lastCompletedStep

            lastCompletedStep?: PlanStep

            The last completed step in the execution plan, if any.

            -

            Optional op

            op?: Op

            The operation to perform. If present and op is "set", the data is applied +

            Optional lastCompletedStep

            lastCompletedStep?: PlanStep

            The last completed step in the execution plan, if any.

            +

            Optional op

            op?: Op

            The operation to perform. If present and op is "set", the data is applied to the first JSON pointer.

            -

            output

            output: object

            The output object associated with the execution plan.

            -

            parallel

            parallel: ParallelExecutionPlan[]

            An array of child ParallelExecutionPlan nodes that can be executed in parallel. +

            output

            output: object

            The output object associated with the execution plan.

            +

            parallel

            parallel: ParallelExecutionPlan[]

            An array of child ParallelExecutionPlan nodes that can be executed in parallel. This forms the root node of a directed acyclic graph (DAG) of ParallelPlanStep's.

            -

            Optional restore

            restore?: boolean

            Optional flag used to mark plans that are being used during a restore operation. +

            Optional restore

            restore?: boolean

            Optional flag used to mark plans that are being used during a restore operation. When true, indicates that this plan is part of restoring a previous template state.

            -

            Optional type

            type?: "serial|parallel"

            Plans can be serialized and stored therefor we need to know what type of ExecutionPlan +

            Optional type

            type?: "serial|parallel"

            Plans can be serialized and stored therefor we need to know what type of ExecutionPlan this is. Defaults to "serial" if not present. Allowed values "serial|parallel"

            -

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/interfaces/Planner.ExecutionPlan.html b/interfaces/Planner.ExecutionPlan.html index f564da13..f10513b2 100644 --- a/interfaces/Planner.ExecutionPlan.html +++ b/interfaces/Planner.ExecutionPlan.html @@ -1,6 +1,6 @@ ExecutionPlan | stated-js

            Interface ExecutionPlan

            Represents an execution plan that defines the steps and operations for initializing, mutating, or restoring a template's state.

            -
            interface ExecutionPlan {
                data?: any;
                forkId: string;
                forkStack: Fork[];
                lastCompletedStep?: PlanStep;
                op?: Op;
                output: object;
                type?: "serial|parallel";
            }

            Hierarchy (view full)

            Properties

            data? +
            interface ExecutionPlan {
                data?: any;
                forkId: string;
                forkStack: Fork[];
                lastCompletedStep?: PlanStep;
                op?: Op;
                output: object;
                type?: "serial|parallel";
            }

            Hierarchy (view full)

            Properties

            data? forkId forkStack lastCompletedStep? @@ -8,14 +8,14 @@ output type?

            Properties

            Optional data

            data?: any

            The data associated with the plan. May be undefined for initialization plans.

            -

            forkId

            forkId: string

            The identifier for the fork associated with this execution plan. Will be "ROOT" when the plan is not +

            forkId

            forkId: string

            The identifier for the fork associated with this execution plan. Will be "ROOT" when the plan is not executing a fork

            -

            forkStack

            forkStack: Fork[]

            The stack of forks involved in this execution plan. Forks will push and pop on top of the ROOT fork +

            forkStack

            forkStack: Fork[]

            The stack of forks involved in this execution plan. Forks will push and pop on top of the ROOT fork corresponding to entering a $forked() and exiting a forked plan on $joined()

            -

            Optional lastCompletedStep

            lastCompletedStep?: PlanStep

            The last completed step in the execution plan, if any.

            -

            Optional op

            op?: Op

            The operation to perform. If present and op is "set", the data is applied +

            Optional lastCompletedStep

            lastCompletedStep?: PlanStep

            The last completed step in the execution plan, if any.

            +

            Optional op

            op?: Op

            The operation to perform. If present and op is "set", the data is applied to the first JSON pointer.

            -

            output

            output: object

            The output object associated with the execution plan.

            -

            Optional type

            type?: "serial|parallel"

            Plans can be serialized and stored therefor we need to know what type of ExecutionPlan +

            output

            output: object

            The output object associated with the execution plan.

            +

            Optional type

            type?: "serial|parallel"

            Plans can be serialized and stored therefor we need to know what type of ExecutionPlan this is. Defaults to "serial" if not present. Allowed values "serial|parallel"

            -

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/interfaces/Planner.Planner.html b/interfaces/Planner.Planner.html index d46f3c27..ef899cca 100644 --- a/interfaces/Planner.Planner.html +++ b/interfaces/Planner.Planner.html @@ -1,6 +1,6 @@ Planner | stated-js

            Interface Planner

            Interface representing a Planner responsible for generating and executing initialization and mutation plans for templates in a TemplateProcessor.

            -
            interface Planner {
                execute(plan): Promise<void>;
                executeDataChangeCallbacks(plan): Promise<void>;
                from(jsonPtr): string[];
                fromJSON(plan, snapshot, forks): ExecutionPlan;
                getInitializationPlan(jsonPointer): ExecutionPlan;
                getMutationPlan(jsonPtr, data, op): [ExecutionPlan, string[]];
                toJSON(mutationPlan): SerializableExecutionPlan;
            }

            Implemented by

            Methods

            execute +
            interface Planner {
                execute(plan): Promise<void>;
                executeDataChangeCallbacks(plan): Promise<void>;
                from(jsonPtr): string[];
                fromJSON(plan, snapshot, forks): ExecutionPlan;
                getInitializationPlan(jsonPointer): ExecutionPlan;
                getMutationPlan(jsonPtr, data, op): [ExecutionPlan, string[]];
                toJSON(mutationPlan): SerializableExecutionPlan;
            }

            Implemented by

            Methods

            execute executeDataChangeCallbacks from fromJSON @@ -12,23 +12,23 @@ to the template or its components.

            Parameters

            Returns Promise<void>

            A promise that resolves once execution is complete.

            -

            executeDataChangeCallbacks

            from

            • from(jsonPtr): string[]

            • Returns a 'total ordering' of the dependency graph. A single array of JSON pointers +

            executeDataChangeCallbacks

            from

            • from(jsonPtr): string[]

            • Returns a 'total ordering' of the dependency graph. A single array of JSON pointers is returned. From always uses the SerialPlanner therefore the returned array of json pointers should only be literally interpreted as the execution plan order when you are using a SerialPlanner. However, the point of from() is to give users of the command line a concise report on which parts of the output the dag will propagate to. In other words, the 'effects' that flow downstream from a mutation applied to jsonPtr

              Parameters

              • jsonPtr: string

              Returns string[]

              JsonPointerString[]

              -

            fromJSON

            • fromJSON(plan, snapshot, forks): ExecutionPlan

            • This is the inverse of the toJSON. It takes a serializable execution plan and returns an object +

            fromJSON

            • fromJSON(plan, snapshot, forks): ExecutionPlan

            • This is the inverse of the toJSON. It takes a serializable execution plan and returns an object that can be used in the runtime.The snapshot is necessary because it contains normalization structures that have to be used to rehydrate an ExecutionPlan from a SerializableExecutionPlan

              -

              Parameters

              Returns ExecutionPlan

            getInitializationPlan

            getInitializationPlan

            • getInitializationPlan(jsonPointer): ExecutionPlan

            • Generates an initialization plan for the specified JSON pointer.

              This method is typically queued by the TemplateProcessor during initialization. While the jsonPointer is often / (the root), it may point to a specific location in the template when $import is called to initialize an imported template.

              Parameters

              • jsonPointer: string

                The JSON pointer indicating the location for initialization.

              Returns ExecutionPlan

              The generated ExecutionPlan for initialization.

              -

            getMutationPlan

            • getMutationPlan(jsonPtr, data, op): [ExecutionPlan, string[]]

            • Generates a mutation plan for the specified JSON pointer and operation.

              +

            getMutationPlan

            • getMutationPlan(jsonPtr, data, op): [ExecutionPlan, string[]]

            • Generates a mutation plan for the specified JSON pointer and operation.

              This method creates a plan responsible for performing mutations on the template. Supported operations include initialize, set, delete, and forceSetInternal.

              @@ -37,5 +37,5 @@

            Returns [ExecutionPlan, string[]]

            [ExecutionPlan, JsonPointerString[]] The generated ExecutionPlan for the mutation and an array telling which expressions must be transitively re-evaluated as a result of the mutation.

            See

            Op

            -

            toJSON

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            toJSON

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/interfaces/SerialPlanner.SerialPlan.html b/interfaces/SerialPlanner.SerialPlan.html index 6ffb3ca8..c1c737dd 100644 --- a/interfaces/SerialPlanner.SerialPlan.html +++ b/interfaces/SerialPlanner.SerialPlan.html @@ -1,6 +1,6 @@ SerialPlan | stated-js

            Interface SerialPlan

            Represents an execution plan that defines the steps and operations for initializing, mutating, or restoring a template's state.

            -
            interface SerialPlan {
                data?: any;
                didUpdate: boolean[];
                forkId: string;
                forkStack: Fork[];
                lastCompletedStep?: PlanStep;
                op?: Op;
                output: object;
                restoreJsonPtrs: string[];
                sortedJsonPtrs: string[];
                type?: "serial|parallel";
            }

            Hierarchy (view full)

            Properties

            data? +
            interface SerialPlan {
                data?: any;
                didUpdate: boolean[];
                forkId: string;
                forkStack: Fork[];
                lastCompletedStep?: PlanStep;
                op?: Op;
                output: object;
                restoreJsonPtrs: string[];
                sortedJsonPtrs: string[];
                type?: "serial|parallel";
            }

            Hierarchy (view full)

            Properties

            data? didUpdate forkId forkStack @@ -11,14 +11,14 @@ sortedJsonPtrs type?

            Properties

            Optional data

            data?: any

            The data associated with the plan. May be undefined for initialization plans.

            -

            didUpdate

            didUpdate: boolean[]

            forkId

            forkId: string

            The identifier for the fork associated with this execution plan. Will be "ROOT" when the plan is not +

            didUpdate

            didUpdate: boolean[]

            forkId

            forkId: string

            The identifier for the fork associated with this execution plan. Will be "ROOT" when the plan is not executing a fork

            -

            forkStack

            forkStack: Fork[]

            The stack of forks involved in this execution plan. Forks will push and pop on top of the ROOT fork +

            forkStack

            forkStack: Fork[]

            The stack of forks involved in this execution plan. Forks will push and pop on top of the ROOT fork corresponding to entering a $forked() and exiting a forked plan on $joined()

            -

            Optional lastCompletedStep

            lastCompletedStep?: PlanStep

            The last completed step in the execution plan, if any.

            -

            Optional op

            op?: Op

            The operation to perform. If present and op is "set", the data is applied +

            Optional lastCompletedStep

            lastCompletedStep?: PlanStep

            The last completed step in the execution plan, if any.

            +

            Optional op

            op?: Op

            The operation to perform. If present and op is "set", the data is applied to the first JSON pointer.

            -

            output

            output: object

            The output object associated with the execution plan.

            -

            restoreJsonPtrs

            restoreJsonPtrs: string[]

            sortedJsonPtrs

            sortedJsonPtrs: string[]

            Optional type

            type?: "serial|parallel"

            Plans can be serialized and stored therefor we need to know what type of ExecutionPlan +

            output

            output: object

            The output object associated with the execution plan.

            +

            restoreJsonPtrs

            restoreJsonPtrs: string[]

            sortedJsonPtrs

            sortedJsonPtrs: string[]

            Optional type

            type?: "serial|parallel"

            Plans can be serialized and stored therefor we need to know what type of ExecutionPlan this is. Defaults to "serial" if not present. Allowed values "serial|parallel"

            -

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/CliCore.html b/modules/CliCore.html index 340671da..c36202e1 100644 --- a/modules/CliCore.html +++ b/modules/CliCore.html @@ -1,2 +1,2 @@ -CliCore | stated-js

            Module CliCore

            Index

            Classes

            default +CliCore | stated-js

            Module CliCore

            Index

            Classes

            default

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/CliCoreBase.html b/modules/CliCoreBase.html index 21c7459d..b5dde322 100644 --- a/modules/CliCoreBase.html +++ b/modules/CliCoreBase.html @@ -1,2 +1,2 @@ -CliCoreBase | stated-js

            Module CliCoreBase

            Index

            Classes

            CliCoreBase +CliCoreBase | stated-js

            Module CliCoreBase

            Index

            Classes

            CliCoreBase

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/ConsoleLogger.html b/modules/ConsoleLogger.html index 4e53ffed..32e9c8eb 100644 --- a/modules/ConsoleLogger.html +++ b/modules/ConsoleLogger.html @@ -1,4 +1,4 @@ -ConsoleLogger | stated-js

            Module ConsoleLogger

            Index

            Classes

            default +ConsoleLogger | stated-js

            Module ConsoleLogger

            Index

            Classes

            default

            Interfaces

            StatedLogger

            Type Aliases

            Levels LogLevel diff --git a/modules/DataFlow.html b/modules/DataFlow.html index c62641ce..8e9d26cd 100644 --- a/modules/DataFlow.html +++ b/modules/DataFlow.html @@ -1,4 +1,4 @@ -DataFlow | stated-js

            Module DataFlow

            Index

            Classes

            DataFlow +DataFlow | stated-js

            Module DataFlow

            Index

            Classes

            DataFlow

            Type Aliases

            DataFlowNode FlowOpt

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/DependencyFinder.html b/modules/DependencyFinder.html index 8b813be7..c525ed5b 100644 --- a/modules/DependencyFinder.html +++ b/modules/DependencyFinder.html @@ -1,2 +1,2 @@ -DependencyFinder | stated-js

            Module DependencyFinder

            Index

            Classes

            default +DependencyFinder | stated-js

            Module DependencyFinder

            Index

            Classes

            default

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/ExecutionStatus.html b/modules/ExecutionStatus.html index bdaf62c9..fe43546c 100644 --- a/modules/ExecutionStatus.html +++ b/modules/ExecutionStatus.html @@ -1,2 +1,2 @@ -ExecutionStatus | stated-js

            Module ExecutionStatus

            Index

            Classes

            ExecutionStatus +ExecutionStatus | stated-js

            Module ExecutionStatus

            Index

            Classes

            ExecutionStatus

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/FancyLogger.html b/modules/FancyLogger.html index f5fd3d84..f71f9466 100644 --- a/modules/FancyLogger.html +++ b/modules/FancyLogger.html @@ -1,2 +1,2 @@ -FancyLogger | stated-js

            Module FancyLogger

            Index

            Classes

            default +FancyLogger | stated-js

            Module FancyLogger

            Index

            Classes

            default

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/JsonPointer.html b/modules/JsonPointer.html index 74727b72..ad0a5029 100644 --- a/modules/JsonPointer.html +++ b/modules/JsonPointer.html @@ -1,4 +1,4 @@ -JsonPointer | stated-js

            Module JsonPointer

            Index

            Classes

            default +JsonPointer | stated-js

            Module JsonPointer

            Index

            Classes

            default

            Type Aliases

            DescentCallback DescentIterator

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/Lifecycle.html b/modules/Lifecycle.html index 40bde936..d664b14f 100644 --- a/modules/Lifecycle.html +++ b/modules/Lifecycle.html @@ -1,4 +1,4 @@ -Lifecycle | stated-js

            Module Lifecycle

            Index

            Enumerations

            LifecycleState +Lifecycle | stated-js

            Module Lifecycle

            Index

            Enumerations

            LifecycleState

            Interfaces

            LifecycleOwner

            Type Aliases

            LifecycleCallback

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/LifecycleManager.html b/modules/LifecycleManager.html index 94d0797d..a46d0d1b 100644 --- a/modules/LifecycleManager.html +++ b/modules/LifecycleManager.html @@ -1,2 +1,2 @@ -LifecycleManager | stated-js

            Module LifecycleManager

            Index

            Classes

            LifecycleManager +LifecycleManager | stated-js

            Module LifecycleManager

            Index

            Classes

            LifecycleManager

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/MetaInfoProducer.html b/modules/MetaInfoProducer.html index 45153fa9..4df753df 100644 --- a/modules/MetaInfoProducer.html +++ b/modules/MetaInfoProducer.html @@ -1,4 +1,4 @@ -MetaInfoProducer | stated-js

            Module MetaInfoProducer

            Index

            Classes

            default +MetaInfoProducer | stated-js

            Module MetaInfoProducer

            Index

            Classes

            default

            Interfaces

            MetaInfo

            Type Aliases

            JsonPointerString JsonPointerStructureArray diff --git a/modules/ParallelExecutionPlan.html b/modules/ParallelExecutionPlan.html index 41495478..6525513b 100644 --- a/modules/ParallelExecutionPlan.html +++ b/modules/ParallelExecutionPlan.html @@ -1,2 +1,2 @@ -ParallelExecutionPlan | stated-js

            Module ParallelExecutionPlan

            Index

            Interfaces

            ParallelExecutionPlan +ParallelExecutionPlan | stated-js

            Module ParallelExecutionPlan

            Index

            Interfaces

            ParallelExecutionPlan

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/ParallelExecutionPlanDefault.html b/modules/ParallelExecutionPlanDefault.html index 6ff63891..4032fa86 100644 --- a/modules/ParallelExecutionPlanDefault.html +++ b/modules/ParallelExecutionPlanDefault.html @@ -1,4 +1,4 @@ -ParallelExecutionPlanDefault | stated-js

            Module ParallelExecutionPlanDefault

            Index

            Classes

            ParallelExecutionPlanDefault +ParallelExecutionPlanDefault | stated-js

            Module ParallelExecutionPlanDefault

            Index

            Classes

            ParallelExecutionPlanDefault

            Type Aliases

            MutationParamsType

            Functions

            isMutation

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/ParallelPlanner.html b/modules/ParallelPlanner.html index c2ce6359..9e1f57ef 100644 --- a/modules/ParallelPlanner.html +++ b/modules/ParallelPlanner.html @@ -1,2 +1,2 @@ -ParallelPlanner | stated-js

            Module ParallelPlanner

            Index

            Classes

            ParallelPlanner +ParallelPlanner | stated-js

            Module ParallelPlanner

            Index

            Classes

            ParallelPlanner

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/Planner.html b/modules/Planner.html index be2544f9..173b1006 100644 --- a/modules/Planner.html +++ b/modules/Planner.html @@ -1,4 +1,4 @@ -Planner | stated-js

            Module Planner

            Index

            Interfaces

            ExecutionPlan +Planner | stated-js

            Module Planner

            Index

            Interfaces

            ExecutionPlan Planner

            Type Aliases

            SerializableExecutionPlan

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/SerialPlanner.html b/modules/SerialPlanner.html index b5404b5e..e9cc4268 100644 --- a/modules/SerialPlanner.html +++ b/modules/SerialPlanner.html @@ -1,3 +1,3 @@ -SerialPlanner | stated-js

            Module SerialPlanner

            Index

            Classes

            SerialPlanner +SerialPlanner | stated-js

            Module SerialPlanner

            Index

            Classes

            SerialPlanner

            Interfaces

            SerialPlan

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/StatedREPL.html b/modules/StatedREPL.html index 44dd421d..e2eca877 100644 --- a/modules/StatedREPL.html +++ b/modules/StatedREPL.html @@ -1,2 +1,2 @@ -StatedREPL | stated-js

            Module StatedREPL

            Index

            Classes

            default +StatedREPL | stated-js

            Module StatedREPL

            Index

            Classes

            default

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/TemplateProcessor.html b/modules/TemplateProcessor.html index e8608d57..afcb95a4 100644 --- a/modules/TemplateProcessor.html +++ b/modules/TemplateProcessor.html @@ -1,4 +1,4 @@ -TemplateProcessor | stated-js

            Module TemplateProcessor

            Index

            Classes

            default +TemplateProcessor | stated-js

            Module TemplateProcessor

            Index

            Classes

            default

            Type Aliases

            DataChangeCallback Fork ForkId diff --git a/modules/TestUtils.html b/modules/TestUtils.html index 0cf237e4..e309256f 100644 --- a/modules/TestUtils.html +++ b/modules/TestUtils.html @@ -1,4 +1,4 @@ -TestUtils | stated-js

            Module TestUtils

            Index

            Type Aliases

            CommandAndResponse +TestUtils | stated-js

            Module TestUtils

            Index

            Type Aliases

            CommandAndResponse

            Functions

            parseMarkdownAndTestCodeblocks parseMarkdownTests

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/TimerManager.html b/modules/TimerManager.html index 3069e243..0bb2db20 100644 --- a/modules/TimerManager.html +++ b/modules/TimerManager.html @@ -1,2 +1,2 @@ -TimerManager | stated-js

            Module TimerManager

            Index

            Classes

            TimerManager +TimerManager | stated-js

            Module TimerManager

            Index

            Classes

            TimerManager

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/TraversalState.html b/modules/TraversalState.html index 9c5173fa..a9ae2127 100644 --- a/modules/TraversalState.html +++ b/modules/TraversalState.html @@ -1,2 +1,2 @@ -TraversalState | stated-js

            Module TraversalState

            Index

            Classes

            TraversalState +TraversalState | stated-js

            Module TraversalState

            Index

            Classes

            TraversalState

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/VizGraph.html b/modules/VizGraph.html index c2483353..912e4563 100644 --- a/modules/VizGraph.html +++ b/modules/VizGraph.html @@ -1,2 +1,2 @@ -VizGraph | stated-js

            Module VizGraph

            Index

            Classes

            default +VizGraph | stated-js

            Module VizGraph

            Index

            Classes

            default

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/index.html b/modules/index.html index 5d4fd7fe..82b4e3ae 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,4 +1,4 @@ -index | stated-js

            Module index

            References

            CliCoreBase +index | stated-js

            Module index

            References

            CliCoreBase DataChangeCallback Fork ForkId diff --git a/types/ConsoleLogger.Levels.html b/types/ConsoleLogger.Levels.html index 293ba12e..33dacab2 100644 --- a/types/ConsoleLogger.Levels.html +++ b/types/ConsoleLogger.Levels.html @@ -1 +1 @@ -Levels | stated-js

            Type alias Levels

            Levels: "silent" | "error" | "warn" | "info" | "verbose" | "debug"

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +Levels | stated-js

            Type alias Levels

            Levels: "silent" | "error" | "warn" | "info" | "verbose" | "debug"

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/ConsoleLogger.LogLevel.html b/types/ConsoleLogger.LogLevel.html index 17afd052..284cf7fc 100644 --- a/types/ConsoleLogger.LogLevel.html +++ b/types/ConsoleLogger.LogLevel.html @@ -1 +1 @@ -LogLevel | stated-js

            Type alias LogLevel

            LogLevel: {
                debug: number;
                error: number;
                info: number;
                silent: number;
                verbose: number;
                warn: number;
            }

            Type declaration

            • debug: number
            • error: number
            • info: number
            • silent: number
            • verbose: number
            • warn: number

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +LogLevel | stated-js

            Type alias LogLevel

            LogLevel: {
                debug: number;
                error: number;
                info: number;
                silent: number;
                verbose: number;
                warn: number;
            }

            Type declaration

            • debug: number
            • error: number
            • info: number
            • silent: number
            • verbose: number
            • warn: number

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/DataFlow.DataFlowNode.html b/types/DataFlow.DataFlowNode.html index aba5bffe..90ca5332 100644 --- a/types/DataFlow.DataFlowNode.html +++ b/types/DataFlow.DataFlowNode.html @@ -1,4 +1,4 @@ DataFlowNode | stated-js

            Type alias DataFlowNode

            DataFlowNode: {
                location: JsonPointerString;
                to?: DataFlowNode[] | DataFlowNode | JsonPointerString;
            } | JsonPointerString

            Represents a node in a data flow structure. A DataFlowNode can either be a JsonPointerString or an object with a location and an optional 'to' field which points to one or more subsequent DataFlowNodes or a JsonPointerString.

            -

            Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/DataFlow.FlowOpt.html b/types/DataFlow.FlowOpt.html index 900db185..1c32c761 100644 --- a/types/DataFlow.FlowOpt.html +++ b/types/DataFlow.FlowOpt.html @@ -1 +1 @@ -FlowOpt | stated-js

            Type alias FlowOpt

            FlowOpt: 0 | 1

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +FlowOpt | stated-js

            Type alias FlowOpt

            FlowOpt: 0 | 1

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/JsonPointer.DescentCallback.html b/types/JsonPointer.DescentCallback.html index 78a30e55..f4e2ed55 100644 --- a/types/JsonPointer.DescentCallback.html +++ b/types/JsonPointer.DescentCallback.html @@ -1 +1 @@ -DescentCallback | stated-js

            Type alias DescentCallback

            DescentCallback: ((value, jsonPointer) => boolean)

            Type declaration

              • (value, jsonPointer): boolean

              • Parameters

                Returns boolean

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +DescentCallback | stated-js

            Type alias DescentCallback

            DescentCallback: ((value, jsonPointer) => boolean)

            Type declaration

              • (value, jsonPointer): boolean

              • Parameters

                Returns boolean

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/JsonPointer.DescentIterator.html b/types/JsonPointer.DescentIterator.html index 2d3a86bb..32037d00 100644 --- a/types/JsonPointer.DescentIterator.html +++ b/types/JsonPointer.DescentIterator.html @@ -1 +1 @@ -DescentIterator | stated-js

            Type alias DescentIterator

            DescentIterator: ((value, localFieldName) => void)

            Type declaration

              • (value, localFieldName): void

              • Parameters

                • value: any
                • localFieldName: string

                Returns void

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +DescentIterator | stated-js

            Type alias DescentIterator

            DescentIterator: ((value, localFieldName) => void)

            Type declaration

              • (value, localFieldName): void

              • Parameters

                • value: any
                • localFieldName: string

                Returns void

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/Lifecycle.LifecycleCallback.html b/types/Lifecycle.LifecycleCallback.html index 5b2a7947..12640502 100644 --- a/types/Lifecycle.LifecycleCallback.html +++ b/types/Lifecycle.LifecycleCallback.html @@ -5,4 +5,4 @@

            Type declaration

              • (state, templateProcessor): Promise<void>

              • Parameters

                • state: LifecycleState

                  The new lifecycle state that the system has transitioned to.

                • templateProcessor: default

                  The TemplateProcessor instance to be used for handling the state transition.

                Returns Promise<void>

            Returns

            A Promise<void> indicating the asynchronous operation is complete.

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/MetaInfoProducer.JsonPointerString.html b/types/MetaInfoProducer.JsonPointerString.html index ea501c77..a693b4da 100644 --- a/types/MetaInfoProducer.JsonPointerString.html +++ b/types/MetaInfoProducer.JsonPointerString.html @@ -1 +1 @@ -JsonPointerString | stated-js

            Type alias JsonPointerString

            JsonPointerString: string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +JsonPointerString | stated-js

            Type alias JsonPointerString

            JsonPointerString: string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/MetaInfoProducer.JsonPointerStructureArray.html b/types/MetaInfoProducer.JsonPointerStructureArray.html index f657af0e..03bcf532 100644 --- a/types/MetaInfoProducer.JsonPointerStructureArray.html +++ b/types/MetaInfoProducer.JsonPointerStructureArray.html @@ -1 +1 @@ -JsonPointerStructureArray | stated-js

            Type alias JsonPointerStructureArray

            JsonPointerStructureArray: (string | number)[]

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +JsonPointerStructureArray | stated-js

            Type alias JsonPointerStructureArray

            JsonPointerStructureArray: (string | number)[]

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/ParallelExecutionPlanDefault.MutationParamsType.html b/types/ParallelExecutionPlanDefault.MutationParamsType.html index 5712bd3b..097e6ff0 100644 --- a/types/ParallelExecutionPlanDefault.MutationParamsType.html +++ b/types/ParallelExecutionPlanDefault.MutationParamsType.html @@ -1 +1 @@ -MutationParamsType | stated-js

            Type alias MutationParamsType

            MutationParamsType: {
                data?: any;
                mutationPlan: ParallelExecutionPlan;
                mutationTarget: string;
                op: Op;
            }

            Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +MutationParamsType | stated-js

            Type alias MutationParamsType

            MutationParamsType: {
                data?: any;
                mutationPlan: ParallelExecutionPlan;
                mutationTarget: string;
                op: Op;
            }

            Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/Planner.SerializableExecutionPlan.html b/types/Planner.SerializableExecutionPlan.html index 1078ba3e..1498ca86 100644 --- a/types/Planner.SerializableExecutionPlan.html +++ b/types/Planner.SerializableExecutionPlan.html @@ -14,4 +14,4 @@ Simplified to contain only ForkId values instead of full Fork objects to make Snapshot objects much smaller in some cases.

            See

            ExecutionPlan

            -

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.DataChangeCallback.html b/types/TemplateProcessor.DataChangeCallback.html index cfb91b13..cc4a725c 100644 --- a/types/TemplateProcessor.DataChangeCallback.html +++ b/types/TemplateProcessor.DataChangeCallback.html @@ -16,4 +16,4 @@ registered on "/", ptr will be an array of JSON pointers into the data field represents the root object.

          • Optional removed: boolean

            (optional) A boolean indicating whether the data was removed. true for delete, false for set.

          • Optional op: Op

            (optional) A string describing the operation. Can be "set", "delete", or "forceSetInternal".

            -

            • Returns void

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.Fork.html b/types/TemplateProcessor.Fork.html index cd0603e1..28de3ec7 100644 --- a/types/TemplateProcessor.Fork.html +++ b/types/TemplateProcessor.Fork.html @@ -1 +1 @@ -Fork | stated-js

            Type alias Fork

            Fork: {
                forkId: ForkId;
                output: object;
            }

            Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +Fork | stated-js

            Type alias Fork

            Fork: {
                forkId: ForkId;
                output: object;
            }

            Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.ForkId.html b/types/TemplateProcessor.ForkId.html index 288ddf4a..3cc3a504 100644 --- a/types/TemplateProcessor.ForkId.html +++ b/types/TemplateProcessor.ForkId.html @@ -1 +1 @@ -ForkId | stated-js

            Type alias ForkId

            ForkId: string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +ForkId | stated-js

            Type alias ForkId

            ForkId: string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.FunctionGenerator.html b/types/TemplateProcessor.FunctionGenerator.html index db07fb49..67465a80 100644 --- a/types/TemplateProcessor.FunctionGenerator.html +++ b/types/TemplateProcessor.FunctionGenerator.html @@ -1,3 +1,3 @@ FunctionGenerator | stated-js

            Type alias FunctionGenerator<T>

            FunctionGenerator<T>: ((context, templateProcessor?) => Promise<((...args) => Promise<any>)> | ((...args) => any))

            a FunctionGenerator is used to generate functions that need the context of which expression they were called from which is made available to them in the MetaInf

            -

            Type Parameters

            • T

            Type declaration

              • (context, templateProcessor?): Promise<((...args) => Promise<any>)> | ((...args) => any)

              • Parameters

                • context: T
                • Optional templateProcessor: default

                Returns Promise<((...args) => Promise<any>)> | ((...args) => any)

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Type Parameters

            • T

            Type declaration

              • (context, templateProcessor?): Promise<((...args) => Promise<any>)> | ((...args) => any)

              • Parameters

                • context: T
                • Optional templateProcessor: default

                Returns Promise<((...args) => Promise<any>)> | ((...args) => any)

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.MetaInfoMap.html b/types/TemplateProcessor.MetaInfoMap.html index 16aaf376..d901dfcd 100644 --- a/types/TemplateProcessor.MetaInfoMap.html +++ b/types/TemplateProcessor.MetaInfoMap.html @@ -1 +1 @@ -MetaInfoMap | stated-js

            Type alias MetaInfoMap

            MetaInfoMap: Record<JsonPointerString, MetaInfo[]>

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +MetaInfoMap | stated-js

            Type alias MetaInfoMap

            MetaInfoMap: Record<JsonPointerString, MetaInfo[]>

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.Mutation.html b/types/TemplateProcessor.Mutation.html index 19968aef..116d3ec9 100644 --- a/types/TemplateProcessor.Mutation.html +++ b/types/TemplateProcessor.Mutation.html @@ -1 +1 @@ -Mutation | stated-js

            Type alias Mutation

            Mutation: {
                data: any;
                jsonPtr: JsonPointerString;
                op: Op;
            }

            Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +Mutation | stated-js

            Type alias Mutation

            Mutation: {
                data: any;
                jsonPtr: JsonPointerString;
                op: Op;
            }

            Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.Op.html b/types/TemplateProcessor.Op.html index 46780a87..8e28e274 100644 --- a/types/TemplateProcessor.Op.html +++ b/types/TemplateProcessor.Op.html @@ -1 +1 @@ -Op | stated-js

            Type alias Op

            Op: "initialize" | "set" | "delete" | "eval" | "forceSetInternal" | "noop"

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +Op | stated-js

            Type alias Op

            Op: "initialize" | "set" | "delete" | "eval" | "forceSetInternal" | "noop"

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.PlanStep.html b/types/TemplateProcessor.PlanStep.html index 2707af28..0bc59c09 100644 --- a/types/TemplateProcessor.PlanStep.html +++ b/types/TemplateProcessor.PlanStep.html @@ -1 +1 @@ -PlanStep | stated-js

            Type alias PlanStep

            PlanStep: {
                data?: any;
                didUpdate: boolean;
                forkId: string;
                forkStack: Fork[];
                jsonPtr: JsonPointerString;
                op?: Op;
                output: object;
            }

            Type declaration

            • Optional data?: any
            • didUpdate: boolean
            • forkId: string
            • forkStack: Fork[]
            • jsonPtr: JsonPointerString
            • Optional op?: Op
            • output: object

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +PlanStep | stated-js

            Type alias PlanStep

            PlanStep: {
                data?: any;
                didUpdate: boolean;
                forkId: string;
                forkStack: Fork[];
                jsonPtr: JsonPointerString;
                op?: Op;
                output: object;
            }

            Type declaration

            • Optional data?: any
            • didUpdate: boolean
            • forkId: string
            • forkStack: Fork[]
            • jsonPtr: JsonPointerString
            • Optional op?: Op
            • output: object

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.Snapshot.html b/types/TemplateProcessor.Snapshot.html index 54cc3025..c371dd8e 100644 --- a/types/TemplateProcessor.Snapshot.html +++ b/types/TemplateProcessor.Snapshot.html @@ -1 +1 @@ -Snapshot | stated-js

            Type alias Snapshot

            Snapshot: {
                metaInfoByJsonPointer: Record<JsonPointerString, MetaInfo[]>;
                mvcc: any;
                options: {};
                output: any;
                plans: SerializableExecutionPlan[];
                template: object;
            }

            Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +Snapshot | stated-js

            Type alias Snapshot

            Snapshot: {
                metaInfoByJsonPointer: Record<JsonPointerString, MetaInfo[]>;
                mvcc: any;
                options: {};
                output: any;
                plans: SerializableExecutionPlan[];
                template: object;
            }

            Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.StatedError.html b/types/TemplateProcessor.StatedError.html index 9c33c72b..d5946f9a 100644 --- a/types/TemplateProcessor.StatedError.html +++ b/types/TemplateProcessor.StatedError.html @@ -1 +1 @@ -StatedError | stated-js

            Type alias StatedError

            StatedError: {
                error: {
                    message: string;
                    name?: string;
                    stack?: string | null;
                };
            }

            Type declaration

            • error: {
                  message: string;
                  name?: string;
                  stack?: string | null;
              }
              • message: string
              • Optional name?: string
              • Optional stack?: string | null

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +StatedError | stated-js

            Type alias StatedError

            StatedError: {
                error: {
                    message: string;
                    name?: string;
                    stack?: string | null;
                };
            }

            Type declaration

            • error: {
                  message: string;
                  name?: string;
                  stack?: string | null;
              }
              • message: string
              • Optional name?: string
              • Optional stack?: string | null

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.Transaction.html b/types/TemplateProcessor.Transaction.html index 6cae5672..7e9b617d 100644 --- a/types/TemplateProcessor.Transaction.html +++ b/types/TemplateProcessor.Transaction.html @@ -1 +1 @@ -Transaction | stated-js

            Type alias Transaction

            Transaction: {
                mutations: Mutation[];
                op: "transaction";
            }

            Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +Transaction | stated-js

            Type alias Transaction

            Transaction: {
                mutations: Mutation[];
                op: "transaction";
            }

            Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TestUtils.CommandAndResponse.html b/types/TestUtils.CommandAndResponse.html index 044e0524..3b1f639e 100644 --- a/types/TestUtils.CommandAndResponse.html +++ b/types/TestUtils.CommandAndResponse.html @@ -1 +1 @@ -CommandAndResponse | stated-js

            Type alias CommandAndResponse

            CommandAndResponse: {
                args: string[];
                cmdName: string;
                expectedResponse: string;
                jsonataExpr: string;
            }

            Type declaration

            • args: string[]
            • cmdName: string
            • expectedResponse: string
            • jsonataExpr: string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +CommandAndResponse | stated-js

            Type alias CommandAndResponse

            CommandAndResponse: {
                args: string[];
                cmdName: string;
                expectedResponse: string;
                jsonataExpr: string;
            }

            Type declaration

            • args: string[]
            • cmdName: string
            • expectedResponse: string
            • jsonataExpr: string

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/variables/ConsoleLogger.LOG_LEVELS.html b/variables/ConsoleLogger.LOG_LEVELS.html index 3f767236..3601e7ce 100644 --- a/variables/ConsoleLogger.LOG_LEVELS.html +++ b/variables/ConsoleLogger.LOG_LEVELS.html @@ -1 +1 @@ -LOG_LEVELS | stated-js

            Variable LOG_LEVELSConst

            LOG_LEVELS: LogLevel = ...

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +LOG_LEVELS | stated-js

            Variable LOG_LEVELSConst

            LOG_LEVELS: LogLevel = ...

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file