diff --git a/classes/CliCore.default.html b/classes/CliCore.default.html index 178a65f7..beeaf0e0 100644 --- a/classes/CliCore.default.html +++ b/classes/CliCore.default.html @@ -1,6 +1,6 @@ default | stated-js

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

Hierarchy (view full)

Constructors

Properties

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

Type declaration

    • (): void | Promise<void>
    • Returns void | Promise<void>

replServer: REPLServer
templateProcessor: default

Methods

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

Constructors

Properties

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

Type declaration

    • (): void | Promise<void>
    • Returns void | Promise<void>

replServer: REPLServer
templateProcessor: default

Methods

  • 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

  • Parameters

    • args: string

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

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

    +

    Returns void

  • Parameters

    • args: string

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

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

  • Parameters

    • directory: string = ...

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

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

    +

Returns Promise<any>

Returns Promise<any>

Generated using TypeDoc

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

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

    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

    Hierarchy (view full)

    Constructors

    Properties

    currentDirectory: string
    logLevel: keyof LogLevel
    onInit: (() => void | Promise<void>)

    Type declaration

      • (): void | Promise<void>
      • Returns void | Promise<void>

    server: Server<typeof IncomingMessage, typeof ServerResponse>
    templateProcessor: default

    Methods

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

    Constructors

    Properties

    currentDirectory: string
    logLevel: keyof LogLevel
    onInit: (() => void | Promise<void>)

    Type declaration

      • (): void | Promise<void>
      • Returns void | Promise<void>

    server: Server<typeof IncomingMessage, typeof ServerResponse>
    templateProcessor: default

    Methods

    • 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

    • Parameters

      • replCmdInputStr: string

      Returns Promise<any>

    • Parameters

      • args: string

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

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

      +

      Returns void

    • Parameters

      • replCmdInputStr: string

      Returns Promise<any>

    • Parameters

      • args: string

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

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

    • Parameters

      • replCmdInputStr: string

      Returns null | object

    • Parameters

      • filepath: string
      • Optional importPath: string

      Returns Promise<any>

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

      +

    Returns Promise<any>

    Returns Promise<any>

    Generated using TypeDoc

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

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

    Implements

    Constructors

    constructor +default | stated-js

    Implements

    Constructors

    Properties

    Methods

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

    Constructors

    Properties

    level: Levels

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    level: Levels

    Methods

    Generated using TypeDoc

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

    Constructors

    constructor +default | stated-js

    Constructors

    Properties

    Constructors

    Properties

    ast: ExprNode
    compiledExpression: Expression
    currentSteps: StepRecord[][]
    dependencies: string[][]
    nodeStack: GeneratedExprNode[]

    Methods

    • Parameters

      • node: GeneratedExprNode

      Returns GeneratedExprNode[]

    • Parameters

      • scopeWeExited: GeneratedExprNode

      Returns void

    • 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

    ast: ExprNode
    compiledExpression: Expression
    currentSteps: StepRecord[][]
    dependencies: string[][]
    nodeStack: GeneratedExprNode[]

    Methods

    • Parameters

      • node: GeneratedExprNode

      Returns GeneratedExprNode[]

    • Parameters

      • scopeWeExited: GeneratedExprNode

      Returns void

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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • jsonatExpr: string

    Returns Promise<default>

    Generated using TypeDoc

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

    Constructors

    constructor +ExecutionStatus | stated-js

    Constructors

    Properties

    metaInfoByJsonPointer: MetaInfoMap
    statuses: Set<Plan>

    Methods

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

      +

    Constructors

    Properties

    metaInfoByJsonPointer: MetaInfoMap
    statuses: Set<Plan>

    Methods

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

      Parameters

      Returns Promise<void>

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

      +

    Returns Promise<void>

    Generated using TypeDoc

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

    Generated using TypeDoc

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

    Constructors

    constructor +default | stated-js

    Constructors

    Methods

    Constructors

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Methods

    Generated using TypeDoc

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

    Constructors

    constructor +default | stated-js

    Constructors

    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

    • Escapes a reference token

      -

      Parameters

      • str: string | number

      Returns string

    • Converts a JSON pointer into an array of reference tokens

      -

      Parameters

      • pointer: string

      Returns string[]

    • Unescapes a reference token

      -

      Parameters

      • str: string

      Returns string

    • Escapes a reference token

      +

      Parameters

      • str: string | number

      Returns string

    • Converts a JSON pointer into an array of reference tokens

      +

      Parameters

      • pointer: string

      Returns string[]

    • Unescapes a reference token

      +

      Parameters

      • str: string

      Returns string

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Generated using TypeDoc

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

    Class for managing lifecycle callbacks.

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    lifecycleCallbacks: Map<LifecycleState, Set<LifecycleCallback>>
    templateProcessor: default

    Methods

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

      +

    Constructors

    Properties

    lifecycleCallbacks: Map<LifecycleState, Set<LifecycleCallback>>
    templateProcessor: default

    Methods

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

      +

    Returns void

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

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

    Constructors

    constructor +default | stated-js

    Constructors

    Properties

    Methods

    Constructors

    Properties

    EMBEDDED_EXPR_REGEX: RegExp = ...

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    EMBEDDED_EXPR_REGEX: RegExp = ...

    Methods

    Generated using TypeDoc

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

    Constructors

    constructor +default | stated-js

    Constructors

    Properties

    cliCore: default
    isColorized: boolean = false
    replServer: REPLServer
    CLICORE_COMMANDS: string[][] = ...

    Methods

    • Parameters

      • cliCoreMethodName: string
      • args: string

      Returns Promise<boolean>

    • Parameters

      • methodName: string
      • result: any

      Returns any

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    cliCore: default
    isColorized: boolean = false
    replServer: REPLServer
    CLICORE_COMMANDS: string[][] = ...

    Methods

    • Parameters

      • cliCoreMethodName: string
      • args: string

      Returns Promise<boolean>

    • Parameters

      • methodName: string
      • result: any

      Returns any

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/TemplateProcessor.default.html b/classes/TemplateProcessor.default.html index 1bdaede0..964c25ef 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

    Constructors

    Properties

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

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

    Constructors

    Properties

    changeCallbacks: Map<string, Set<DataChangeCallback>>

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

    -
    context: any

    Contextual data for the template processing.

    -
    debugger: any

    Debugger utility for the template processor.

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

    Contains any errors encountered during template processing.

    -

    Type declaration

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

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

    Constructors

    Properties

    changeCallbacks: Map<string, Set<DataChangeCallback>>

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

    +
    context: any

    Contextual data for the template processing.

    +
    debugger: any

    Debugger utility for the template processor.

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

    Contains any errors encountered during template processing.

    +

    Type declaration

    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

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

    A queue of execution plans awaiting processing.

    -
    executionStatus: ExecutionStatus
    functionGenerators: Map<string, FunctionGenerator>

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

    Type declaration

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

    A queue of execution plans awaiting processing.

    +
    executionStatus: ExecutionStatus
    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). @@ -132,26 +132,26 @@

    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.

    -

    generatorManager: GeneratorManager
    input: any

    Represents the raw input for the template processor.

    -
    isClosed: boolean = false
    isInitializing: boolean

    Flag indicating if the template processor is currently initializing.

    -
    lifecycleManager: LifecycleOwner = ...
    logger: StatedLogger

    Represents the logger used within the template processor.

    -
    metaInfoByJsonPointer: MetaInfoMap = {}

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

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

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

    +
    generatorManager: GeneratorManager
    input: any

    Represents the raw input for the template processor.

    +
    isClosed: boolean = false
    isInitializing: boolean

    Flag indicating if the template processor is currently initializing.

    +
    lifecycleManager: LifecycleOwner = ...
    logger: StatedLogger

    Represents the logger used within the template processor.

    +
    metaInfoByJsonPointer: MetaInfoMap = {}

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

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

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

    Type declaration

      • (): void | Promise<void>
      • Returns void | Promise<void>

    Deprecated

    use lifecycleManager instead

    -
    options: any = {}

    Configuration options for the template processor.

    -
    output: {} = {}

    Contains the processed output after template processing.

    -

    Type declaration

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

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

      options: any = {}

      Configuration options for the template processor.

      +
      output: {} = {}

      Contains the processed output after template processing.

      +

      Type declaration

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

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

        Type declaration

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

            Returns Promise<void>

            Deprecated

            use lifecycleManager instead

        Deprecated

        use lifecycleManager instead

        -
        tagSet: Set<string>

        A set of tags associated with the template.

        -
        tempVars: string[] = []
        templateMeta: any

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

        tagSet: Set<string>

        A set of tags associated with the template.

        +
        tempVars: string[] = []
        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

        -
        timerManager: TimerManager
        uniqueId: string

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

        -
        warnings: any[] = []

        List of warnings generated during template processing.

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

        Default set of functions provided for the template processor.

        +
        timerManager: TimerManager
        uniqueId: string

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

        +
        warnings: any[] = []

        List of warnings generated during template processing.

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

                @@ -172,14 +172,14 @@

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

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

                • T extends AnyFunction

                Parameters

                • func: T
                • maxWait: number = 1000

                Returns T

        Remarks

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

        -

        Static

        NOOP: symbol = ...
        _isNodeJS: boolean = ...

        Methods

        NOOP: symbol = ...
        _isNodeJS: boolean = ...

        Methods

        Returns Promise<void>

        Returns void

        Returns void

        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();
        -

        Generated using TypeDoc

        \ No newline at end of file +

        Static

        Generated using TypeDoc

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

        Constructors

        constructor +TimerManager | stated-js

        Constructors

        Properties

        intervals: Set<Timeout>
        jsonPointerByInterval: Map<Timeout, string>
        timeouts: Set<Timeout>

        Methods

        • Parameters

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

            • (interval): Promise<void>
            • Parameters

              • interval: Timeout

              Returns Promise<void>

        • 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

        • Parameters

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

                • Rest ...args: any[]

                Returns void

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

          Returns Timeout

        • Parameters

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

                • Rest ...args: any[]

                Returns void

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

          Returns Timeout

        Generated using TypeDoc

        \ No newline at end of file +

        Constructors

        Properties

        intervals: Set<Timeout>
        jsonPointerByInterval: Map<Timeout, string>
        timeouts: Set<Timeout>

        Methods

        • Parameters

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

            • (interval): Promise<void>
            • Parameters

              • interval: Timeout

              Returns Promise<void>

        • 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

        • Parameters

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

                • Rest ...args: any[]

                Returns void

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

          Returns Timeout

        • Parameters

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

                • Rest ...args: any[]

                Returns void

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

          Returns Timeout

        Generated using TypeDoc

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

        Constructors

        constructor +default | stated-js

        Constructors

        Methods

        • Parameters

          • str: string

          Returns string

        Generated using TypeDoc

        \ No newline at end of file +

        Constructors

        Methods

        • Parameters

          • str: string

          Returns string

        Generated using TypeDoc

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

        Enumeration LifecycleState

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

        -

        Enumeration Members

        Enumeration Members

        Closed: "Closed"

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

        -
        Initialized: "Initialized"

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

        -
        PreTmpVarRemoval: "PreTmpVarRemoval"

        The state before temporary variables are removed from the system.

        -
        StartClose: "StartClose"

        The state when the process to close the system begins.

        -
        StartInitialize: "StartInitialize"

        The state representing the start of the initialization process.

        -

        Generated using TypeDoc

        \ No newline at end of file +
        Initialized: "Initialized"

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

        +
        PreTmpVarRemoval: "PreTmpVarRemoval"

        The state before temporary variables are removed from the system.

        +
        StartClose: "StartClose"

        The state when the process to close the system begins.

        +
        StartInitialize: "StartInitialize"

        The state representing the start of the initialization process.

        +

        Generated using TypeDoc

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

        Function parseMarkdownAndTestCodeblocks

        • Parameters

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

                • k: any
                • v: any

                Returns any

          Returns Promise<void>

        Generated using TypeDoc

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

        Function parseMarkdownAndTestCodeblocks

        • Parameters

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

                • k: any
                • v: any

                Returns any

          Returns Promise<void>

        Generated using TypeDoc

        \ No newline at end of file diff --git a/functions/TestUtils.parseMarkdownTests.html b/functions/TestUtils.parseMarkdownTests.html index 63962a99..a9c4bd4f 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.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/functions/index.stringifyTemplateJSON.html b/functions/index.stringifyTemplateJSON.html index 386e39b1..297de606 100644 --- a/functions/index.stringifyTemplateJSON.html +++ b/functions/index.stringifyTemplateJSON.html @@ -1 +1 @@ -stringifyTemplateJSON | stated-js

        Function stringifyTemplateJSON

        • Parameters

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

                • key: any
                • value: any

                Returns any

          Returns string

        Generated using TypeDoc

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

        Function stringifyTemplateJSON

        • Parameters

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

                • key: any
                • value: any

                Returns any

          Returns string

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/ConsoleLogger.StatedLogger.html b/interfaces/ConsoleLogger.StatedLogger.html index 16a52409..390102fb 100644 --- a/interfaces/ConsoleLogger.StatedLogger.html +++ b/interfaces/ConsoleLogger.StatedLogger.html @@ -1,8 +1,8 @@ -StatedLogger | stated-js
        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 {
            level: Levels;
            debug(...args): void;
            error(...args): void;
            info(...args): void;
            log(level, ...args): void;
            verbose(...args): void;
            warn(...args): void;
        }

        Implemented by

        Properties

        Methods

        Properties

        level: Levels

        Methods

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        level: Levels

        Methods

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/Lifecycle.LifecycleOwner.html b/interfaces/Lifecycle.LifecycleOwner.html index 81cc4cf0..45b1d881 100644 --- a/interfaces/Lifecycle.LifecycleOwner.html +++ b/interfaces/Lifecycle.LifecycleOwner.html @@ -1,10 +1,10 @@ LifecycleOwner | stated-js

        Interface LifecycleOwner

        Interface for managing lifecycle callbacks.

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

        Implemented by

        Methods

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

        Implemented by

        Methods

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

          Parameters

          • state: LifecycleState

            The lifecycle state to remove the callback from.

          • Optional cbFn: LifecycleCallback

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

            -

          Returns void

        • Registers a lifecycle callback for a specific lifecycle state.

          +

        Returns void

        • Registers a lifecycle callback for a specific lifecycle state.

          Parameters

          • state: LifecycleState

            The lifecycle state to register the callback for.

          • cbFn: LifecycleCallback

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

            -

          Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/interfaces/MetaInfoProducer.MetaInfo.html b/interfaces/MetaInfoProducer.MetaInfo.html index 65738bb2..10620ff5 100644 --- a/interfaces/MetaInfoProducer.MetaInfo.html +++ b/interfaces/MetaInfoProducer.MetaInfo.html @@ -1,4 +1,4 @@ -MetaInfo | stated-js
        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 {
            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__: 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

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        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

        Generated using TypeDoc

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

        Module CliCore

        Index

        Classes

        default +CliCore | stated-js

        Generated using TypeDoc

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

        Module CliCoreBase

        Index

        Classes

        CliCoreBase +CliCoreBase | stated-js

        Generated using TypeDoc

        \ No newline at end of file diff --git a/modules/ConsoleLogger.html b/modules/ConsoleLogger.html index 4e361772..8d365b63 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

        Interfaces

        Type Aliases

        Levels LogLevel diff --git a/modules/DependencyFinder.html b/modules/DependencyFinder.html index 71162ac7..af2950a4 100644 --- a/modules/DependencyFinder.html +++ b/modules/DependencyFinder.html @@ -1,2 +1,2 @@ -DependencyFinder | stated-js

        Module DependencyFinder

        Index

        Classes

        default +DependencyFinder | stated-js

        Generated using TypeDoc

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

        Module ExecutionStatus

        Index

        Classes

        ExecutionStatus +ExecutionStatus | stated-js

        Generated using TypeDoc

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

        Module FancyLogger

        Index

        Classes

        default +FancyLogger | stated-js

        Generated using TypeDoc

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

        Module JsonPointer

        Index

        Classes

        default +JsonPointer | stated-js

        Generated using TypeDoc

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

        Module Lifecycle

        Index

        Enumerations

        LifecycleState +Lifecycle | stated-js

        Generated using TypeDoc

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

        Module LifecycleManager

        Index

        Classes

        LifecycleManager +LifecycleManager | stated-js

        Generated using TypeDoc

        \ No newline at end of file diff --git a/modules/MetaInfoProducer.html b/modules/MetaInfoProducer.html index 32785f17..206bee19 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

        Interfaces

        Type Aliases

        JsonPointerString JsonPointerStructureArray diff --git a/modules/StatedREPL.html b/modules/StatedREPL.html index c24101c5..fc2c68a8 100644 --- a/modules/StatedREPL.html +++ b/modules/StatedREPL.html @@ -1,2 +1,2 @@ -StatedREPL | stated-js

        Module StatedREPL

        Index

        Classes

        default +StatedREPL | stated-js

        Generated using TypeDoc

        \ No newline at end of file diff --git a/modules/TemplateProcessor.html b/modules/TemplateProcessor.html index 7069868b..40d38aa9 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

        Type Aliases

        DataChangeCallback Fork FunctionGenerator diff --git a/modules/TestUtils.html b/modules/TestUtils.html index d4f5050e..ce444de3 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

        Generated using TypeDoc

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

        Module TimerManager

        Index

        Classes

        TimerManager +TimerManager | stated-js

        Generated using TypeDoc

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

        Module VizGraph

        Index

        Classes

        default +VizGraph | stated-js

        Generated using TypeDoc

        \ No newline at end of file diff --git a/modules/index.html b/modules/index.html index a787d3de..b7aaded2 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 28ce85ca..12ff6c7a 100644 --- a/types/ConsoleLogger.Levels.html +++ b/types/ConsoleLogger.Levels.html @@ -1 +1 @@ -Levels | stated-js
        Levels: "silent" | "error" | "warn" | "info" | "verbose" | "debug"

        Generated using TypeDoc

        \ No newline at end of file +Levels | stated-js
        Levels: "silent" | "error" | "warn" | "info" | "verbose" | "debug"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/ConsoleLogger.LogLevel.html b/types/ConsoleLogger.LogLevel.html index 14e99a50..4592cf26 100644 --- a/types/ConsoleLogger.LogLevel.html +++ b/types/ConsoleLogger.LogLevel.html @@ -1 +1 @@ -LogLevel | stated-js
        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

        Generated using TypeDoc

        \ No newline at end of file +LogLevel | stated-js
        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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/JsonPointer.DescentCallback.html b/types/JsonPointer.DescentCallback.html index 8b377d84..71e6d1a0 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

        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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/JsonPointer.DescentIterator.html b/types/JsonPointer.DescentIterator.html index c4c7d917..4e371bca 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

        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

        Generated using TypeDoc

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

        Type declaration

          • (state, templateProcessor): Promise<void>
          • Parameters

            • state: LifecycleState

              The new lifecycle state that the system has transitioned to.

            • templateProcessor: default

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

            Returns Promise<void>

        Returns

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

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

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

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/MetaInfoProducer.JsonPointerStructureArray.html b/types/MetaInfoProducer.JsonPointerStructureArray.html index 0ba309dc..53177f1d 100644 --- a/types/MetaInfoProducer.JsonPointerStructureArray.html +++ b/types/MetaInfoProducer.JsonPointerStructureArray.html @@ -1 +1 @@ -JsonPointerStructureArray | stated-js

        Generated using TypeDoc

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

        Generated using TypeDoc

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

      • Optional removed: boolean

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

      • Optional op: Op

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

        -
      • Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/TemplateProcessor.Fork.html b/types/TemplateProcessor.Fork.html index 70fbd0a8..9d6911c4 100644 --- a/types/TemplateProcessor.Fork.html +++ b/types/TemplateProcessor.Fork.html @@ -1 +1 @@ -Fork | stated-js
        Fork: {
            forkId: string;
            output: object;
        }

        Type declaration

        • forkId: string
        • output: object

        Generated using TypeDoc

        \ No newline at end of file +Fork | stated-js
        Fork: {
            forkId: string;
            output: object;
        }

        Type declaration

        • forkId: string
        • output: object

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/TemplateProcessor.FunctionGenerator.html b/types/TemplateProcessor.FunctionGenerator.html index 7c242b43..a080792a 100644 --- a/types/TemplateProcessor.FunctionGenerator.html +++ b/types/TemplateProcessor.FunctionGenerator.html @@ -1,3 +1,3 @@ FunctionGenerator | stated-js
        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>)>

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

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

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

        Generated using TypeDoc

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

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/TemplateProcessor.Mutation.html b/types/TemplateProcessor.Mutation.html index 3ad2ea3d..dd64961d 100644 --- a/types/TemplateProcessor.Mutation.html +++ b/types/TemplateProcessor.Mutation.html @@ -1 +1 @@ -Mutation | stated-js
        Mutation: {
            data: any;
            jsonPtr: JsonPointerString;
            op: Op;
        }

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +Mutation | stated-js
        Mutation: {
            data: any;
            jsonPtr: JsonPointerString;
            op: Op;
        }

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/TemplateProcessor.Op.html b/types/TemplateProcessor.Op.html index bd7c5938..84d82eff 100644 --- a/types/TemplateProcessor.Op.html +++ b/types/TemplateProcessor.Op.html @@ -1 +1 @@ -Op | stated-js

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/TemplateProcessor.Plan.html b/types/TemplateProcessor.Plan.html index 54190c44..b708a266 100644 --- a/types/TemplateProcessor.Plan.html +++ b/types/TemplateProcessor.Plan.html @@ -1 +1 @@ -Plan | stated-js
        Plan: {
            data?: any;
            didUpdate: boolean[];
            forkId: string;
            forkStack: Fork[];
            lastCompletedStep?: PlanStep;
            op?: Op;
            output: object;
            restoreJsonPtrs: JsonPointerString[];
            sortedJsonPtrs: JsonPointerString[];
        }

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +Plan | stated-js
        Plan: {
            data?: any;
            didUpdate: boolean[];
            forkId: string;
            forkStack: Fork[];
            lastCompletedStep?: PlanStep;
            op?: Op;
            output: object;
            restoreJsonPtrs: JsonPointerString[];
            sortedJsonPtrs: JsonPointerString[];
        }

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/TemplateProcessor.PlanStep.html b/types/TemplateProcessor.PlanStep.html index 460a0369..f6236740 100644 --- a/types/TemplateProcessor.PlanStep.html +++ b/types/TemplateProcessor.PlanStep.html @@ -1 +1 @@ -PlanStep | stated-js
        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

        Generated using TypeDoc

        \ No newline at end of file +PlanStep | stated-js
        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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/types/TemplateProcessor.Snapshot.html b/types/TemplateProcessor.Snapshot.html index 27597026..74c511fd 100644 --- a/types/TemplateProcessor.Snapshot.html +++ b/types/TemplateProcessor.Snapshot.html @@ -1 +1 @@ -Snapshot | stated-js
        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

          Generated using TypeDoc

          \ No newline at end of file +Snapshot | stated-js
          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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.StatedError.html b/types/TemplateProcessor.StatedError.html index 91053127..bafdad87 100644 --- a/types/TemplateProcessor.StatedError.html +++ b/types/TemplateProcessor.StatedError.html @@ -1 +1 @@ -StatedError | stated-js
            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

            Generated using TypeDoc

            \ No newline at end of file +StatedError | stated-js
            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

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.Transaction.html b/types/TemplateProcessor.Transaction.html index d4e7ba58..d12822e7 100644 --- a/types/TemplateProcessor.Transaction.html +++ b/types/TemplateProcessor.Transaction.html @@ -1 +1 @@ -Transaction | stated-js
            Transaction: {
                mutations: Mutation[];
                op: "transaction";
            }

            Type declaration

            Generated using TypeDoc

            \ No newline at end of file +Transaction | stated-js
            Transaction: {
                mutations: Mutation[];
                op: "transaction";
            }

            Type declaration

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TestUtils.CommandAndResponse.html b/types/TestUtils.CommandAndResponse.html index 0604a38d..7bc689e8 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

            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

            Generated using TypeDoc

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

            Generated using TypeDoc

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

            Generated using TypeDoc

            \ No newline at end of file