From b02d55a757038e026de0466ad85e718e568e92c1 Mon Sep 17 00:00:00 2001 From: geoffhendrey Date: Fri, 27 Sep 2024 16:17:11 +0000 Subject: [PATCH] deploy: 95da3f457244ac134d9af66a6f19fd29bc3fb5b2 --- classes/CliCore.default.html | 12 +-- classes/CliCoreBase.CliCoreBase.html | 12 +-- classes/ConsoleLogger.default.html | 4 +- classes/DependencyFinder.default.html | 6 +- classes/ExecutionStatus.ExecutionStatus.html | 8 +- classes/FancyLogger.default.html | 4 +- classes/JsonPointer.default.html | 24 +++--- classes/MetaInfoProducer.default.html | 4 +- classes/StatedREPL.default.html | 4 +- classes/TemplateProcessor.default.html | 76 +++++++++---------- classes/TimerManager.TimerManager.html | 4 +- classes/VizGraph.default.html | 4 +- ...tUtils.parseMarkdownAndTestCodeblocks.html | 2 +- functions/TestUtils.parseMarkdownTests.html | 2 +- functions/index.stringifyTemplateJSON.html | 2 +- interfaces/ConsoleLogger.StatedLogger.html | 4 +- interfaces/MetaInfoProducer.MetaInfo.html | 4 +- modules/CliCore.html | 2 +- modules/CliCoreBase.html | 2 +- modules/ConsoleLogger.html | 2 +- modules/DependencyFinder.html | 2 +- modules/ExecutionStatus.html | 2 +- modules/FancyLogger.html | 2 +- modules/JsonPointer.html | 2 +- modules/MetaInfoProducer.html | 2 +- modules/StatedREPL.html | 2 +- modules/TemplateProcessor.html | 2 +- modules/TestUtils.html | 2 +- modules/TimerManager.html | 2 +- modules/VizGraph.html | 2 +- modules/index.html | 2 +- types/ConsoleLogger.Levels.html | 2 +- types/ConsoleLogger.LogLevel.html | 2 +- types/JsonPointer.DescentCallback.html | 2 +- types/JsonPointer.DescentIterator.html | 2 +- types/MetaInfoProducer.JsonPointerString.html | 2 +- ...nfoProducer.JsonPointerStructureArray.html | 2 +- .../TemplateProcessor.DataChangeCallback.html | 2 +- types/TemplateProcessor.Fork.html | 2 +- .../TemplateProcessor.FunctionGenerator.html | 2 +- types/TemplateProcessor.MetaInfoMap.html | 2 +- types/TemplateProcessor.Op.html | 2 +- types/TemplateProcessor.Plan.html | 2 +- types/TemplateProcessor.PlanStep.html | 2 +- types/TemplateProcessor.Snapshot.html | 2 +- types/TemplateProcessor.StatedError.html | 2 +- types/TestUtils.CommandAndResponse.html | 2 +- variables/ConsoleLogger.LOG_LEVELS.html | 2 +- 48 files changed, 119 insertions(+), 119 deletions(-) diff --git a/classes/CliCore.default.html b/classes/CliCore.default.html index ce9eb8bd..cdef4322 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 @@ -30,18 +30,18 @@ minimistArgs parseInitArgs 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;
    }

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;
    }

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

out

plan

readFileAndParse

restore

  • restore(replCmdInputStr): Promise<any>

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

    +

Returns Promise<any>

log

note

out

plan

readFileAndParse

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 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 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 fb44420c..b4d5a44a 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 @@ -32,18 +32,18 @@ minimistArgs parseInitArgs 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;
      }

    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;
      }

    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

    readFileAndParse

    • readFileAndParse(filepath, importPath?): Promise<any>

    • Parameters

      • filepath: string
      • Optional importPath: string

      Returns Promise<any>

    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

    readFileAndParse

    • readFileAndParse(filepath, importPath?): Promise<any>

    • Parameters

      • filepath: string
      • Optional importPath: string

      Returns Promise<any>

    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 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 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 534ca661..a3a2d9a9 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/DependencyFinder.default.html b/classes/DependencyFinder.default.html index 67038940..0e0b144a 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 @@ -22,8 +22,8 @@ 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[]

    Methods

    ancestors

    captureArrayIndexes

    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

      • 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[]

    Methods

    ancestors

    captureArrayIndexes

    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 99f2e0bb..0eb4252c 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 statuses tp @@ -14,8 +14,8 @@ toJsonString createExecutionStatusFromJson jsonToMetaInfos -

    Constructors

    constructor

    Properties

    metaInfoByJsonPointer

    metaInfoByJsonPointer: MetaInfoMap

    statuses

    statuses: Set<Plan>

    tp

    tp: default

    Methods

    begin

    clear

    end

    getForkMap

    Private metaInfosToJSON

    Private mutationPlanToJSON

    Private planStepToJSON

    restore

    • restore(tp): Promise<void>

    • Restores ExecutionStatuses, initialize plans and executes all plans in-flight

      +

    Constructors

    constructor

    Properties

    metaInfoByJsonPointer

    metaInfoByJsonPointer: MetaInfoMap

    statuses

    statuses: Set<Plan>

    tp

    tp: default

    Methods

    begin

    clear

    end

    getForkMap

    Private metaInfosToJSON

    Private mutationPlanToJSON

    Private planStepToJSON

    restore

    • restore(tp): Promise<void>

    • Restores ExecutionStatuses, initialize plans and executes all plans in-flight

      Parameters

      Returns Promise<void>

    toJsonObject

    toJsonString

    Static createExecutionStatusFromJson

    • createExecutionStatusFromJson(tp, obj): ExecutionStatus

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

      +

    Returns Promise<void>

    toJsonObject

    toJsonString

    Static createExecutionStatusFromJson

    Static Private jsonToMetaInfos

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • obj: any

    • Returns ExecutionStatus

    Static Private jsonToMetaInfos

    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 a81ab491..d0bfd512 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 1c92e8b9..3d7e4ba9 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 @@ -15,15 +15,15 @@ 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 parent

    Static parse

    • parse(pointer): string[]

    • Converts a JSON pointer into an array of reference tokens

      -

      Parameters

      • pointer: string

      Returns string[]

    Static remove

    Static set

    Static unescape

    • unescape(str): string

    • Unescapes a reference token

      -

      Parameters

      • str: string

      Returns string

    Static walk

    Static compile

    Static dict

    Static escape

    • escape(str): string

    • Escapes a reference token

      +

      Parameters

      • str: string | number

      Returns string

    Static get

    Static has

    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 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/MetaInfoProducer.default.html b/classes/MetaInfoProducer.default.html index 684a99cc..6241c0e6 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/StatedREPL.default.html b/classes/StatedREPL.default.html index 30350dd3..53842238 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<void>

    • Parameters

      • cliCoreMethodName: string
      • args: string

      Returns Promise<void>

    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<void>

    • Parameters

      • cliCoreMethodName: string
      • args: string

      Returns Promise<void>

    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 28590e16..3aaaa29c 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 @@ -111,14 +111,14 @@

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

    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: (Plan | SnapshotPlan)[] = []

    A queue of execution plans awaiting processing.

    -

    executionStatus

    executionStatus: ExecutionStatus

    functionGenerators

    functionGenerators: Map<string, FunctionGenerator>

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

    Type declaration

    Private Readonly executionQueue

    executionQueue: (Plan | SnapshotPlan)[] = []

    A queue of execution plans awaiting processing.

    +

    executionStatus

    executionStatus: ExecutionStatus

    functionGenerators

    functionGenerators: Map<string, FunctionGenerator>

    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). @@ -127,23 +127,23 @@

    Example: React to changes using data change callbacks on various locations i is actually genrated 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.

    -

    input

    input: any

    Represents the raw input for the template processor.

    -

    Private isClosed

    isClosed: boolean = false

    Private isInitializing

    isInitializing: boolean

    Flag indicating if the template processor is currently initializing.

    -

    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.

    -

    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>

    options

    options: any = {}

    Configuration options for the template processor.

    -

    output

    output: {} = {}

    Contains the processed output after template processing.

    -

    Type declaration

      postInitialize

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

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

      input

      input: any

      Represents the raw input for the template processor.

      +

      Private isClosed

      isClosed: boolean = false

      Private isInitializing

      isInitializing: boolean

      Flag indicating if the template processor is currently initializing.

      +

      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.

      +

      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>

      options

      options: any = {}

      Configuration options for the template processor.

      +

      output

      output: {} = {}

      Contains the processed output after template processing.

      +

      Type declaration

        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

        Deprecated

        tagSet

        tagSet: Set<string>

        A set of tags associated with the template.

        -

        Private tempVars

        tempVars: string[] = []

        templateMeta

        templateMeta: any

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

        Returns Promise<void>

        Deprecated

        Deprecated

        tagSet

        tagSet: Set<string>

        A set of tags associated with the template.

        +

        Private tempVars

        tempVars: string[] = []

        templateMeta

        templateMeta: any

        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

        -

        Private 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.

        +

        Private 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.

                @@ -164,24 +164,24 @@

                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

        • allTagsPresent(tagSetOnTheExpression): boolean

        • Parameters

          • tagSetOnTheExpression: Set<string>

          Returns boolean

        Private applyMutationToFirstJsonPointerOfPlan

        Private cacheTmpVarLocations

        Private callDataChangeCallbacks

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

        • Parameters

          • data: any
          • jsonPointer: string | string[]
          • removed: boolean = false

          Returns Promise<void>

        close

        Private createMetaInfos

        createRestorePlan

        • createRestorePlan(plan): Promise<void>

        • Create an initialization plan from the execution plan

          -

          Parameters

          Returns Promise<void>

        Private drainExecutionQueue

        Private evaluateInitialPlan

        evaluateInitialPlanDependencies

        Private evaluateNode

        evaluateRestorePlan

        • evaluateRestorePlan(plan): Promise<void>

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

          +

        Private allTagsPresent

        • allTagsPresent(tagSetOnTheExpression): boolean

        • Parameters

          • tagSetOnTheExpression: Set<string>

          Returns boolean

        Private applyMutationToFirstJsonPointerOfPlan

        Private cacheTmpVarLocations

        Private callDataChangeCallbacks

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

        • Parameters

          • data: any
          • jsonPointer: string | string[]
          • removed: boolean = false

          Returns Promise<void>

        close

        Private createMetaInfos

        createRestorePlan

        • createRestorePlan(plan): Promise<void>

        • Create an initialization plan from the execution plan

          +

          Parameters

          Returns Promise<void>

        Private drainExecutionQueue

        Private evaluateInitialPlan

        evaluateInitialPlanDependencies

        Private evaluateNode

        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>

        Private executeDataChangeCallbacks

        Private executeDependentExpressions

        executePlan

        Private extractFragmentIfNeeded

        Private fetchFromURL

        from

        Private generateDeferFunction

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

        • Parameters

          • metaInfo: any

          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 +

          Parameters

          Returns Promise<void>

        Private executeDataChangeCallbacks

        Private executeDependentExpressions

        executePlan

        Private extractFragmentIfNeeded

        Private fetchFromURL

        from

        Private generateDeferFunction

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

        • Parameters

          • metaInfo: any

          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 getDependentsBFS

        getEvaluationPlan

        Private getImport

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

        • Parameters

          Returns ((templateToImport) => Promise<symbol>)

            • (templateToImport): Promise<symbol>

            • Parameters

              • templateToImport: string

              Returns Promise<symbol>

        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

          +

          Parameters

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

        getDependencies

        getDependents

        Private getDependentsBFS

        getEvaluationPlan

        Private getImport

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

        • Parameters

          Returns ((templateToImport) => Promise<symbol>)

            • (templateToImport): Promise<symbol>

            • Parameters

              • templateToImport: string

              Returns Promise<symbol>

        import

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

        • Parameters

          • template: string | object
          • jsonPtrImportPath: string

          Returns Promise<void>

        initialize

        initializeFromExecutionStatusString

        • initializeFromExecutionStatusString(exectuionStatusStr): Promise<void>

        • Parameters

          • exectuionStatusStr: string

          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 +

        • executionStatusSnapshot: undefined | {} = undefined

        Returns Promise<void>

        initializeFromExecutionStatusString

        • initializeFromExecutionStatusString(exectuionStatusStr): Promise<void>

        • Parameters

          • exectuionStatusStr: string

          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

        Private mutate

        out

        Private parseURL

        Private populateTemplateMeta

        Private propagateTags

        removeDataChangeCallback

        Private removeLeadingDollarsFromDependencies

        Private removeTemporaryVariables

        • removeTemporaryVariables(tmpVars, jsonPtrOfTemplate): void

        • Parameters

          • tmpVars: string[]
          • jsonPtrOfTemplate: string

          Returns void

        Private resetTemplate

        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

          Returns boolean

        Private localImport

        Private logOutput

        Private makeDepsAbsolute

        Private mutate

        out

        Private parseURL

        Private populateTemplateMeta

        Private propagateTags

        removeDataChangeCallback

        Private removeLeadingDollarsFromDependencies

        Private removeTemporaryVariables

        • removeTemporaryVariables(tmpVars, jsonPtrOfTemplate): void

        • Parameters

          • tmpVars: string[]
          • jsonPtrOfTemplate: string

          Returns void

        Private resetTemplate

        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(planStep): Promise<string[]>

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

        Returns void

        setDataForked

        • setDataForked(planStep): 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>

        Private setUntrackedLocation

        setupContext

        Private setupDependees

        snapshot

        • snapshot(): Promise<string>

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

          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>

        Private setUntrackedLocation

        setupContext

        Private setupDependees

        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 topologicalSort

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

        • Parameters

          • metaInfos: MetaInfo[]
          • exprsOnly: boolean = true
          • fanout: boolean = true

          Returns string[]

        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

        Private 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

        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 topologicalSort

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

        • Parameters

          • metaInfos: MetaInfo[]
          • exprsOnly: boolean = true
          • fanout: boolean = true

          Returns string[]

        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

        Private 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

        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.

            @@ -218,10 +218,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 fromExecutionStatusString

          Static fromString

          Static load

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

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

            +

            Parameters

            • output: object

            Returns any

          Static Private dependsOnImportedTemplate

          Static fromExecutionStatusString

          Static fromString

          Static load

          • load(template, context?): 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.

              Returns Promise<default>

              Returns an initialized instance of TemplateProcessor.

              -

              Static

            Static Private simpleUniqueId

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Static

            Static Private simpleUniqueId

            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 0ad8cc2c..69558555 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

            clearAll

            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

            clearAll

            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/VizGraph.default.html b/classes/VizGraph.default.html index 8fbc5909..0f0d0204 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: 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: string

              Returns string

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file diff --git a/functions/TestUtils.parseMarkdownAndTestCodeblocks.html b/functions/TestUtils.parseMarkdownAndTestCodeblocks.html index f6d6ffde..ef67c53c 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 03bf67f4..4642d34b 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 dce051c3..106b2607 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 2c18964c..a29b44a4 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/MetaInfoProducer.MetaInfo.html b/interfaces/MetaInfoProducer.MetaInfo.html index bc4744c8..2d7dfa6f 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;
                jsonPointer__: string | JsonPointerStructureArray;
                materialized__: boolean;
                parent__: string | JsonPointerStructureArray;
                tags__: Set<string>;
                temp__?: boolean;
                treeHasExpressions__: boolean;
            }

            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;
                jsonPointer__: string | JsonPointerStructureArray;
                materialized__: boolean;
                parent__: string | JsonPointerStructureArray;
                tags__: Set<string>;
                temp__?: boolean;
                treeHasExpressions__: boolean;
            }

            Properties

            absoluteDependencies__ compiledExpr__? data__? dependees__ @@ -13,4 +13,4 @@ tags__ temp__? treeHasExpressions__ -

            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

            jsonPointer__

            jsonPointer__: string | JsonPointerStructureArray

            materialized__

            materialized__: boolean

            parent__

            parent__: string | JsonPointerStructureArray

            tags__

            tags__: Set<string>

            Optional temp__

            temp__?: boolean

            treeHasExpressions__

            treeHasExpressions__: boolean

            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

            jsonPointer__

            jsonPointer__: string | JsonPointerStructureArray

            materialized__

            materialized__: boolean

            parent__

            parent__: string | JsonPointerStructureArray

            tags__

            tags__: Set<string>

            Optional temp__

            temp__?: boolean

            treeHasExpressions__

            treeHasExpressions__: boolean

            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 88aa2e05..2bb7b75d 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 59906a8f..5ae243d2 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 2a53b9f9..140769db 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/DependencyFinder.html b/modules/DependencyFinder.html index a8efe629..f0ee57b8 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 a3214982..bc77ffaf 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 1c46678d..d507650c 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 3ecfab18..b0fde16c 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/MetaInfoProducer.html b/modules/MetaInfoProducer.html index 20d53474..c274b7b0 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/StatedREPL.html b/modules/StatedREPL.html index fec55662..43ee86fc 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 0c04d694..e463db9c 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 FunctionGenerator diff --git a/modules/TestUtils.html b/modules/TestUtils.html index 93d5e688..6156976d 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 6129d1f7..d5b682c8 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/VizGraph.html b/modules/VizGraph.html index 88f3eb0c..862ae190 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 6aa6051d..47682ebc 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 FunctionGenerator diff --git a/types/ConsoleLogger.Levels.html b/types/ConsoleLogger.Levels.html index 0fbe2230..38069cbe 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 fc4feafb..4a9a1241 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/JsonPointer.DescentCallback.html b/types/JsonPointer.DescentCallback.html index 016fe09e..f60061d1 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 2a5498ba..e9cf6d90 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/MetaInfoProducer.JsonPointerString.html b/types/MetaInfoProducer.JsonPointerString.html index e12ee756..4c0ee407 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 e4d2a010..9521536f 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/TemplateProcessor.DataChangeCallback.html b/types/TemplateProcessor.DataChangeCallback.html index 3896b733..98e0217d 100644 --- a/types/TemplateProcessor.DataChangeCallback.html +++ b/types/TemplateProcessor.DataChangeCallback.html @@ -1,2 +1,2 @@ DataChangeCallback | stated-js

            Type alias DataChangeCallback

            DataChangeCallback: ((data, ptr, removed?) => void)

            defines the function signature for data change callbacks, called when data at the ptr changes

            -

            Type declaration

              • (data, ptr, removed?): void

              • Parameters

                Returns void

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Type declaration

              • (data, ptr, removed?): void

              • Parameters

                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 aa7379f8..b77cfd8b 100644 --- a/types/TemplateProcessor.Fork.html +++ b/types/TemplateProcessor.Fork.html @@ -1 +1 @@ -Fork | stated-js

            Type alias Fork

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

            Type declaration

            • forkId: string
            • output: object

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

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

            Type alias Fork

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

            Type declaration

            • forkId: string
            • output: object

            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 d8ea062a..2edaf3ed 100644 --- a/types/TemplateProcessor.FunctionGenerator.html +++ b/types/TemplateProcessor.FunctionGenerator.html @@ -1,3 +1,3 @@ FunctionGenerator | stated-js

            Type alias FunctionGenerator

            FunctionGenerator: ((metaInfo, templateProcessor) => Promise<((arg) => Promise<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 declaration

              • (metaInfo, templateProcessor): Promise<((arg) => Promise<any>)>

              • Parameters

                Returns Promise<((arg) => Promise<any>)>

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file +

            Type declaration

              • (metaInfo, templateProcessor): Promise<((arg) => Promise<any>)>

              • Parameters

                Returns Promise<((arg) => Promise<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 eb2a09a8..434f5cb8 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.Op.html b/types/TemplateProcessor.Op.html index ae1258ea..8d51acc4 100644 --- a/types/TemplateProcessor.Op.html +++ b/types/TemplateProcessor.Op.html @@ -1 +1 @@ -Op | stated-js

            Type alias Op

            Op: "set" | "delete" | "forceSetInternal"

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

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

            Type alias Op

            Op: "set" | "delete" | "forceSetInternal"

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.Plan.html b/types/TemplateProcessor.Plan.html index 9eaad720..472e6ae1 100644 --- a/types/TemplateProcessor.Plan.html +++ b/types/TemplateProcessor.Plan.html @@ -1 +1 @@ -Plan | stated-js

            Type alias Plan

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

            Type declaration

            Settings

            Member Visibility

            Theme

            Generated using TypeDoc

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

            Type alias Plan

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

            Type declaration

            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 f5f4b42a..8b4530f1 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 29446a69..801b02c7 100644 --- a/types/TemplateProcessor.Snapshot.html +++ b/types/TemplateProcessor.Snapshot.html @@ -1 +1 @@ -Snapshot | stated-js

            Type alias Snapshot

            Snapshot: {
                metaInfoByJsonPointer: any;
                mvcc: any;
                options: {};
                output: any;
                plans: any;
                template: object;
            }

            Type declaration

            • metaInfoByJsonPointer: any
            • mvcc: any
            • options: {}
              • output: any
              • plans: any
              • template: object

              Settings

              Member Visibility

              Theme

              Generated using TypeDoc

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

              Type alias Snapshot

              Snapshot: {
                  metaInfoByJsonPointer: any;
                  mvcc: any;
                  options: {};
                  output: any;
                  plans: any;
                  template: object;
              }

              Type declaration

              • metaInfoByJsonPointer: any
              • mvcc: any
              • options: {}
                • output: any
                • plans: any
                • template: object

                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 70ec7be1..30ea01fa 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/TestUtils.CommandAndResponse.html b/types/TestUtils.CommandAndResponse.html index abdd9dfa..e334df95 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 c0fd2d50..8ddba603 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