diff --git a/classes/CliCore.default.html b/classes/CliCore.default.html index 790f4246..b9f0597e 100644 --- a/classes/CliCore.default.html +++ b/classes/CliCore.default.html @@ -1,4 +1,4 @@ -default | stated-js

Class default

Constructors

constructor +default | stated-js

Class default

Constructors

constructor

Properties

currentDirectory logLevel onInit @@ -30,13 +30,13 @@ minimistArgs parseInitArgs resolveImportPath -

Constructors

constructor

Properties

Private currentDirectory

currentDirectory: string

Private logLevel

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

onInit

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

Type declaration

    • (): void | Promise<void>

    • Returns void | Promise<void>

replServer

replServer: REPLServer

Private server

server: any

Private templateProcessor

templateProcessor: default

Methods

cd

  • cd(newDirectory): string

  • Parameters

    • newDirectory: string

    Returns string

close

debug

  • debug(replCmdInputStr): Promise<any>

  • Parameters

    • replCmdInputStr: any

    Returns Promise<any>

errors

Private extractArgsInfo

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

  • Parameters

    • args: any

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

from

in

init

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

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

    +

Constructors

constructor

Properties

Private currentDirectory

currentDirectory: string

Private logLevel

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

onInit

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

Type declaration

    • (): void | Promise<void>

    • Returns void | Promise<void>

replServer

replServer: REPLServer

Private server

server: any

Private templateProcessor

templateProcessor: default

Methods

cd

  • cd(newDirectory): string

  • Parameters

    • newDirectory: string

    Returns string

close

debug

  • debug(replCmdInputStr): Promise<any>

  • Parameters

    • replCmdInputStr: any

    Returns Promise<any>

errors

Private extractArgsInfo

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

  • Parameters

    • args: any

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

from

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: any
    • fromSnapshot: boolean = false

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

      -

    Returns Promise<any>

log

  • log(level): {
        log level: any;
    }

  • Parameters

    • level: any

    Returns {
        log level: any;
    }

    • log level: any

note

open

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

  • Parameters

    • directory: string = ...

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

Private openFile

  • openFile(fname): Promise<any>

  • Parameters

    • fname: string

    Returns Promise<any>

out

  • out(replCmdInputStr): any

  • Parameters

    • replCmdInputStr: any

    Returns any

plan

readFileAndParse

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

  • Parameters

    • filepath: any
    • Optional importPath: any

    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

open

Private openFile

out

plan

readFileAndParse

restore

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 +

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 diff --git a/classes/ConsoleLogger.default.html b/classes/ConsoleLogger.default.html index a95c5410..87379299 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: string

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: string

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/Debugger.default.html b/classes/Debugger.default.html index 24a60c56..da5e49ef 100644 --- a/classes/Debugger.default.html +++ b/classes/Debugger.default.html @@ -1,5 +1,5 @@ default | stated-js

Class default

Debugger class that manages breakpoints.

-

Constructors

constructor +

Constructors

constructor

Properties

_breakpoints _templateMeta logger @@ -8,10 +8,10 @@ processCommands removeBreakpoint setBreakpoint -

Constructors

constructor

Properties

Private _breakpoints

_breakpoints: Map<any, any>

Private _templateMeta

_templateMeta: any

logger

logger: any

Methods

enableBreakpoint

  • enableBreakpoint(metaInfo, enabled): void

  • Parameters

    • metaInfo: any
    • enabled: any

    Returns void

listBreakpoints

  • listBreakpoints(): any

  • Lists all breakpoints.

    +

Constructors

constructor

Properties

Private _breakpoints

_breakpoints: Map<any, any>

Private _templateMeta

_templateMeta: any

logger

logger: any

Methods

enableBreakpoint

  • enableBreakpoint(metaInfo, enabled): void

  • Parameters

    • metaInfo: any
    • enabled: any

    Returns void

listBreakpoints

  • listBreakpoints(): any

  • Lists all breakpoints.

    Returns any

    • An array of breakpoint identifiers.
    -

processCommands

  • processCommands(commands): {
        breakpoints: any[];
        messages: any[];
    }

  • Parameters

    • commands: any

    Returns {
        breakpoints: any[];
        messages: any[];
    }

    • breakpoints: any[]
    • messages: any[]

removeBreakpoint

  • removeBreakpoint(metaInfo): void

  • Clears a breakpoint at the specified identifier.

    -

    Parameters

    • metaInfo: any

    Returns void

setBreakpoint

  • setBreakpoint(metaInfo, handler): void

  • Sets a breakpoint at the specified identifier.

    -

    Parameters

    • metaInfo: any
    • handler: any

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

processCommands

removeBreakpoint

setBreakpoint

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 b8f612e2..ea8a75b8 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

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

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 0938160d..73893032 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

statuses

Methods

begin clear @@ -8,4 +8,4 @@ restore toJsonObject toJsonString -

Constructors

constructor

Properties

Private statuses

statuses: Set<MutationPlan>

Methods

begin

clear

end

Private mutationPlanToJSON

Private planStepToJSON

restore

toJsonObject

toJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private statuses

statuses: Set<MutationPlan>

Methods

begin

clear

end

Private mutationPlanToJSON

Private planStepToJSON

restore

toJsonObject

toJsonString

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 4680133a..57c9b164 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 de0273ed..57729526 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

  • obj: any
  • pointer: any
  • value: any

Returns any

Static compile

  • compile(refTokens): string

  • Builds a JSON pointer from an array of reference tokens

    -

    Parameters

    • refTokens: any

    Returns string

Static dict

  • dict(obj, descend): {}

  • Returns a (pointer -> value) dictionary for an object

    -

    Parameters

    • obj: any
    • descend: any

    Returns {}

    Static escape

    Static get

    • get(obj, pointer): any

    • Lookup a JSON pointer in an object

      -

      Parameters

      • obj: any
      • pointer: any

      Returns any

    Static has

    • has(obj, pointer): boolean

    • Tests if an object has a value for a JSON pointer

      -

      Parameters

      • obj: any
      • pointer: any

      Returns boolean

    Static parent

    Static parse

    • parse(pointer): any

    • Converts a JSON pointer into an array of reference tokens

      -

      Parameters

      • pointer: any

      Returns any

    Static remove

    • remove(obj, pointer): void

    • Removes an attribute

      -

      Parameters

      • obj: any
      • pointer: any

      Returns void

    Static set

    Static unescape

    Static walk

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

    • Iterates over an object +

      Parameters

      • obj: any
      • pointer: any
      • value: any

      Returns any

    Static compile

    • compile(refTokens): string

    • Builds a JSON pointer from an array of reference tokens

      +

      Parameters

      • refTokens: any

      Returns string

    Static dict

    • dict(obj, descend): {}

    • Returns a (pointer -> value) dictionary for an object

      +

      Parameters

      • obj: any
      • descend: any

      Returns {}

      Static escape

      Static get

      • get(obj, pointer): any

      • Lookup a JSON pointer in an object

        +

        Parameters

        • obj: any
        • pointer: any

        Returns any

      Static has

      • has(obj, pointer): boolean

      • Tests if an object has a value for a JSON pointer

        +

        Parameters

        • obj: any
        • pointer: any

        Returns boolean

      Static parent

      Static parse

      • parse(pointer): any

      • Converts a JSON pointer into an array of reference tokens

        +

        Parameters

        • pointer: any

        Returns any

      Static remove

      • remove(obj, pointer): void

      • Removes an attribute

        +

        Parameters

        • obj: any
        • pointer: any

        Returns void

      Static set

      Static unescape

      Static walk

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

      • Iterates over an object Iterator: function (value, pointer) {}

        -

        Parameters

        • obj: any
        • iterator: any
        • Optional descend: any

        Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Parameters

      • obj: any
      • iterator: any
      • Optional descend: any

      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 df9e1844..04ef662f 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 5c9fa4e7..fe1ecb7c 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 r @@ -11,4 +11,4 @@ colorize printFunc stringify -

      Constructors

      constructor

      Properties

      Private Readonly cliCore

      cliCore: default

      Private isColorized

      isColorized: boolean

      r

      r: REPLServer

      Static CLICORE_COMMANDS

      CLICORE_COMMANDS: string[][] = ...

      Methods

      cli

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

      • Parameters

        • cliCoreMethodName: any
        • args: any

        Returns Promise<void>

      close

      initialize

      registerCommands

      Private tookOverIO

      • tookOverIO(methodName, result): any

      • Parameters

        • methodName: any
        • result: any

        Returns any

      Static colorize

      Static printFunc

      Static stringify

      • stringify(o, printFunction?): string

      • Parameters

        • o: any
        • Optional printFunction: ((k, v) => any)
            • (k, v): any

            • Parameters

              • k: any
              • v: any

              Returns any

        Returns string

      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

      r

      r: REPLServer

      Static CLICORE_COMMANDS

      CLICORE_COMMANDS: string[][] = ...

      Methods

      cli

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

      • Parameters

        • cliCoreMethodName: any
        • args: any

        Returns Promise<void>

      close

      initialize

      registerCommands

      Private tookOverIO

      • tookOverIO(methodName, result): any

      • Parameters

        • methodName: any
        • result: any

        Returns any

      Static colorize

      Static printFunc

      Static stringify

      • stringify(o, printFunction?): string

      • Parameters

        • o: any
        • Optional printFunction: ((k, v) => any)
            • (k, v): any

            • Parameters

              • k: any
              • v: any

              Returns any

        Returns string

      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 6578f187..7b1c83c9 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 @@ -109,14 +109,14 @@

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

      Constructors

      constructor

      Properties

      Private changeCallbacks

      changeCallbacks: Map<string, Set<((data, jsonPointer, removed) => void)>>

      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: {}

      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<((data, jsonPointer, removed) => void)>>

        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: {}

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

          A queue of execution plans awaiting processing.

          -

          executionStatus

          executionStatus: ExecutionStatus

          functionGenerators

          functionGenerators: Map<string, ((metaInfo, templateProcessor) => Promise<((arg) => Promise<any>)>)>

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

          Type declaration

          Private Readonly executionQueue

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

          A queue of execution plans awaiting processing.

          +

          executionStatus

          executionStatus: ExecutionStatus

          functionGenerators

          functionGenerators: Map<string, ((metaInfo, templateProcessor) => Promise<((arg) => Promise<any>)>)>

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

          -

          Type declaration

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

            • Parameters

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

          input

          input: any

          Represents the raw input for the template processor.

          -

          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

            pro

            pro: any

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

            Type declaration

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

              • Parameters

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

            input

            input: any

            Represents the raw input for the template processor.

            +

            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

              pro

              pro: any

              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.

              -

              Param: planStep

              tagSet

              tagSet: Set<unknown>

              A set of tags associated with the template.

              -

              Private tempVars

              tempVars: string[]

              templateMeta

              templateMeta: any

              Meta information related to the template being processed.

              -

              Private timerManager

              timerManager: TimerManager

              Private Readonly uniqueId

              uniqueId: any

              A unique identifier for the template processor instance.

              -

              warnings

              warnings: any[]

              List of warnings generated during template processing.

              -

              Static DEFAULT_FUNCTIONS

              DEFAULT_FUNCTIONS: {
                  Date: DateConstructor;
                  clearInterval: {
                      (id): void;
                      (intervalId): void;
                  };
                  console: Console;
                  debounce: (<T>(func, wait?) => T);
                  fetch: ((url, opts?) => Promise<Response>);
                  rateLimit: (<T>(func, maxWait?) => T);
                  setInterval: typeof setInterval;
                  setTimeout: typeof setTimeout;
              } = ...

              Default set of functions provided for the template processor.

              +

              Param: planStep

              tagSet

              tagSet: Set<unknown>

              A set of tags associated with the template.

              +

              Private tempVars

              tempVars: string[]

              templateMeta

              templateMeta: any

              Meta information related to the template being processed.

              +

              Private timerManager

              timerManager: TimerManager

              Private Readonly uniqueId

              uniqueId: any

              A unique identifier for the template processor instance.

              +

              warnings

              warnings: any[]

              List of warnings generated during template processing.

              +

              Static DEFAULT_FUNCTIONS

              DEFAULT_FUNCTIONS: {
                  Date: DateConstructor;
                  clearInterval: {
                      (id): void;
                      (intervalId): void;
                  };
                  console: Console;
                  debounce: (<T>(func, wait?) => T);
                  fetch: ((url, opts?) => Promise<Response>);
                  rateLimit: (<T>(func, maxWait?) => T);
                  setInterval: typeof setInterval;
                  setTimeout: typeof setTimeout;
              } = ...

              Default set of functions provided for the template processor.

              Type declaration

              • Date: DateConstructor
              • clearInterval: {
                    (id): void;
                    (intervalId): void;
                }
                  • (id): void

                  • MDN Reference

                    Parameters

                    • id: number

                    Returns void

                  • (intervalId): void

                  • Cancels a Timeout object created by setInterval().

                    Parameters

                    • intervalId: string | number | Timeout

                    Returns void

                    Since

                    v0.0.1

                    @@ -165,21 +165,21 @@

                    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

              • setInterval: typeof setInterval
              • setTimeout: typeof setTimeout

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

              NOOP: symbol = ...

              Static Private _isNodeJS

              _isNodeJS: boolean = ...

              Methods

              Private _evaluateExprNode

              Private _evaluateExpression

              Private _setData

              Private _strictChecks

              Private adjustRootForSimpleExpressionImports

              Static Private NOOP

              NOOP: symbol = ...

              Static Private _isNodeJS

              _isNodeJS: boolean = ...

              Methods

              Private _evaluateExprNode

              Private _evaluateExpression

              Private _setData

              Private _strictChecks

              Private adjustRootForSimpleExpressionImports

              Private allTagsPresent

              Private applyMutationToFirstJsonPointerOfPlan

              Private cacheTmpVarLocations

              Private callDataChangeCallbacks

              close

              Private createMetaInfos

              Private drainExecutionQueue

              Private evaluateInitialPlan

              Private evaluateInitialPlanDependencies

              Private evaluateNode

              Private executeDataChangeCallbacks

              Private executeDependentExpressions

              Private executePlan

              Private extractFragmentIfNeeded

              Private fetchFromURL

              from

              Private generateDeferFunction

              Private generateErrorReportFunction

              Private generateForked

              Private allTagsPresent

              Private applyMutationToFirstJsonPointerOfPlan

              Private cacheTmpVarLocations

              Private callDataChangeCallbacks

              close

              Private createMetaInfos

              Private drainExecutionQueue

              Private evaluateInitialPlan

              Private evaluateInitialPlanDependencies

              Private evaluateNode

              Private executeDataChangeCallbacks

              Private executeDependentExpressions

              Private executePlan

              Private extractFragmentIfNeeded

              Private fetchFromURL

              from

              Private generateDeferFunction

              Private generateErrorReportFunction

              Private generateForked

              Private generateJoined

              Private generateJoined

              Private generateSet

              Private generateSet

              getDependencies

              getDependents

              Private getDependentsBFS

              getEvaluationPlan

              Private getImport

              import

              initialize

              getDependencies

              getDependents

              Private getDependentsBFS

              getEvaluationPlan

              Private getImport

              import

              initialize

              initializeFromSnapshotObject

              Returns Promise<void>

              initializeFromSnapshotObject

              Private isEnabled

              Private localImport

              Private logOutput

              Private makeDepsAbsolute

              Private mutate

              out

              Private parseURL

              Private populateTemplateMeta

              Private propagateTags

              removeDataChangeCallback

              Private removeLeadingDollarsFromDependencies

              Private removeTemporaryVariables

              Private resetTemplate

              Private setContentInTemplate

              setData

              Private isEnabled

              Private localImport

              Private logOutput

              Private makeDepsAbsolute

              Private mutate

              out

              Private parseURL

              Private populateTemplateMeta

              Private propagateTags

              removeDataChangeCallback

              Private removeLeadingDollarsFromDependencies

              Private removeTemporaryVariables

              Private resetTemplate

              Private setContentInTemplate

              setData

              setDataChangeCallback

              setDataChangeCallback

              setDataForked

              Private setDataIntoTrackedLocation

              setExpression

              Private setUntrackedLocation

              setupContext

              Private setupDependees

              snapshot

              Returns void

              setDataForked

              Private setDataIntoTrackedLocation

              setExpression

              Private setUntrackedLocation

              setupContext

              Private setupDependees

              snapshot

              Private sortMetaInfos

              to

              Private topologicalSort

              Private validateAsJSON

              Private withErrorHandling

              Private wrapInOrdinaryFunction

              Static Private compileToJsonPointer

              Static constructFromSnapshotObject

              Private sortMetaInfos

              to

              Private topologicalSort

              Private validateAsJSON

              Private withErrorHandling

              Private wrapInOrdinaryFunction

              Static Private compileToJsonPointer

              Static constructFromSnapshotObject

              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

              Static Private deepCopy

              Static Private dependsOnImportedTemplate

              Static fromSnapshotString

              Static Private dependsOnImportedTemplate

              Static fromSnapshotString

              Static fromString

              Static Private getAncestors

              Static load

              Static fromString

              Static Private getAncestors

              Static load

              Static Private prepareSnapshotInPlace

              Static Private prepareSnapshotInPlace

              Returns Promise<void>

              Static Private simpleUniqueId

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file +

              Returns Promise<void>

              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 ff58ea2e..be404358 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 timeouts

              Methods

              clearAll @@ -9,4 +9,4 @@ isInterval setInterval setTimeout -

              Constructors

              constructor

              Properties

              Private intervals

              intervals: Set<Timeout>

              Private timeouts

              timeouts: Set<Timeout>

              Methods

              clearAll

              clearAllIntervals

              clearAllTimeouts

              clearInterval

              clearTimeout

              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 timeouts

              timeouts: Set<Timeout>

              Methods

              clearAll

              clearAllIntervals

              clearAllTimeouts

              clearInterval

              clearTimeout

              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 626b998a..32a7d8d3 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

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file +

              Constructors

              constructor

              Methods

              Static dot

              Static escapeSpecialCharacters

              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 f04381ee..6878fbc7 100644 --- a/functions/TestUtils.parseMarkdownAndTestCodeblocks.html +++ b/functions/TestUtils.parseMarkdownAndTestCodeblocks.html @@ -1 +1 @@ -parseMarkdownAndTestCodeblocks | stated-js

              Function parseMarkdownAndTestCodeblocks

              • parseMarkdownAndTestCodeblocks(md, cliCore, printFunction?): void

              • Parameters

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

                    • Parameters

                      • k: any
                      • v: any

                      Returns any

                Returns void

              Settings

              Member Visibility

              Theme

              Generated using TypeDoc

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

              Function parseMarkdownAndTestCodeblocks

              • parseMarkdownAndTestCodeblocks(md, cliCore, printFunction?): void

              • Parameters

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

                    • Parameters

                      • k: any
                      • v: any

                      Returns any

                Returns 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 1630cbe0..f5da87fa 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/interfaces/ConsoleLogger.StatedLogger.html b/interfaces/ConsoleLogger.StatedLogger.html index 2573842f..ce2702da 100644 --- a/interfaces/ConsoleLogger.StatedLogger.html +++ b/interfaces/ConsoleLogger.StatedLogger.html @@ -1,8 +1,8 @@ -StatedLogger | stated-js

              Interface StatedLogger

              interface StatedLogger {
                  level: string;
                  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: string;
                  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: string

              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: string

              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 c3d533c5..e8e20b2c 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 b3fd82f6..976de283 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/ConsoleLogger.html b/modules/ConsoleLogger.html index fceba1ce..a60349a7 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

              Variables

              LOG_LEVELS

              Settings

              Member Visibility

              Theme

              Generated using TypeDoc

              \ No newline at end of file diff --git a/modules/Debugger.html b/modules/Debugger.html index 7c5c2545..30fd6fd5 100644 --- a/modules/Debugger.html +++ b/modules/Debugger.html @@ -1,2 +1,2 @@ -Debugger | stated-js

              Module Debugger

              Index

              Classes

              default +Debugger | stated-js

              Module Debugger

              Index

              Classes

              default

              Settings

              Member Visibility

              Theme

              Generated using TypeDoc

              \ No newline at end of file diff --git a/modules/DependencyFinder.html b/modules/DependencyFinder.html index 2888bc9c..4cb5cec9 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 cc83ad21..4d009f10 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 5f73180d..6b4d6c1c 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 ef10b658..c6dad12e 100644 --- a/modules/JsonPointer.html +++ b/modules/JsonPointer.html @@ -1,2 +1,2 @@ -JsonPointer | stated-js

              Module JsonPointer

              Index

              Classes

              default +JsonPointer | stated-js

              Module JsonPointer

              Index

              Classes

              default

              Settings

              Member Visibility

              Theme

              Generated using TypeDoc

              \ No newline at end of file diff --git a/modules/MetaInfoProducer.html b/modules/MetaInfoProducer.html index 0c63f0de..3cdd7021 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 ab751636..87dc9409 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 e69ddeaa..1e7454d4 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

              Fork MutationPlan Op diff --git a/modules/TestUtils.html b/modules/TestUtils.html index fef7df4a..fc1a5f15 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 cf395a04..85991a7b 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 a3bca878..92a1925a 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/types/MetaInfoProducer.JsonPointerString.html b/types/MetaInfoProducer.JsonPointerString.html index 2e764695..1ea15d9a 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 5f02770f..cb56cb56 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.Fork.html b/types/TemplateProcessor.Fork.html index 3d20c019..f14beecc 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.MutationPlan.html b/types/TemplateProcessor.MutationPlan.html index 81eec3bd..de171663 100644 --- a/types/TemplateProcessor.MutationPlan.html +++ b/types/TemplateProcessor.MutationPlan.html @@ -1 +1 @@ -MutationPlan | stated-js

              Type alias MutationPlan

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

              Type declaration

              Settings

              Member Visibility

              Theme

              Generated using TypeDoc

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

              Type alias MutationPlan

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

              Type declaration

              Settings

              Member Visibility

              Theme

              Generated using TypeDoc

              \ No newline at end of file diff --git a/types/TemplateProcessor.Op.html b/types/TemplateProcessor.Op.html index f24d6e91..93d07cd6 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.PlanStep.html b/types/TemplateProcessor.PlanStep.html index fcdd6a68..e17412aa 100644 --- a/types/TemplateProcessor.PlanStep.html +++ b/types/TemplateProcessor.PlanStep.html @@ -1 +1 @@ -PlanStep | stated-js

              Type alias PlanStep

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

              Type declaration

              Settings

              Member Visibility

              Theme

              Generated using TypeDoc

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

              Type alias PlanStep

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

              Type declaration

              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 01b1f951..2ec9d97c 100644 --- a/types/TemplateProcessor.Snapshot.html +++ b/types/TemplateProcessor.Snapshot.html @@ -1 +1 @@ -Snapshot | stated-js

              Type alias Snapshot

              Snapshot: {
                  options: {};
                  output: any;
                  prepared?: boolean;
                  template: object;
              }

              Type declaration

              • options: {}
                • output: any
                • Optional prepared?: boolean
                • template: object

                Settings

                Member Visibility

                Theme

                Generated using TypeDoc

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

                Type alias Snapshot

                Snapshot: {
                    options: {};
                    output: any;
                    prepared?: boolean;
                    template: object;
                }

                Type declaration

                • options: {}
                  • output: any
                  • Optional prepared?: boolean
                  • 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 939275d5..bfc82405 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 69f39044..2d0136d6 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 f40d2049..df4e2214 100644 --- a/variables/ConsoleLogger.LOG_LEVELS.html +++ b/variables/ConsoleLogger.LOG_LEVELS.html @@ -1 +1 @@ -LOG_LEVELS | stated-js

                  Variable LOG_LEVELSConst

                  LOG_LEVELS: {
                      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 +LOG_LEVELS | stated-js

                  Variable LOG_LEVELSConst

                  LOG_LEVELS: {
                      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