From 6fadf8d34deefa1e07c2c55268c887fec930bb8d Mon Sep 17 00:00:00 2001 From: automate Date: Tue, 2 Jul 2024 03:00:30 +0000 Subject: [PATCH] Generate docs Source: 1d05c35851f9cb008c397c260f64792ecf7a0889 --- master/classes/Jsonnet.html | 40 ++++++++++++------------- master/classes/JsonnetError.html | 2 +- master/types/JsonnetPrimitiveValue.html | 2 +- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/master/classes/Jsonnet.html b/master/classes/Jsonnet.html index 09db4d6..13ee701 100644 --- a/master/classes/Jsonnet.html +++ b/master/classes/Jsonnet.html @@ -1,5 +1,5 @@ Jsonnet | @hanazuki/node-jsonnet

Class Jsonnet

Jsonnet is a Jsonnet interpreter. It has a fluent interface: all the setter methods modify the receiver and return it.

-

Constructors

constructor +

Constructors

constructor

Properties

version

Methods

addJpath evaluateFile @@ -19,45 +19,45 @@ tlaCode tlaString

Constructors

constructor

Properties

Static Readonlyversion

version: string

Returns the version of linked libjsonnet.

-

Methods

addJpath

  • addJpath(path): this

  • Adds a path to the list of include paths. Paths added more recently take precedence.

    +

    Returns Jsonnet

Properties

Static Readonlyversion

version: string

Returns the version of linked libjsonnet.

+

Methods

addJpath

  • addJpath(path): this

  • Adds a path to the list of include paths. Paths added more recently take precedence.

    Parameters

    • path: string

      Path to add.

      -

    Returns this

evaluateFile

  • evaluateFile(filename): Promise<string>

  • Evaluates a Jsonnet script in a file.

    +

Returns this

evaluateFile

  • evaluateFile(filename): Promise<string>

  • Evaluates a Jsonnet script in a file.

    Parameters

    • filename: string

      Path to the file.

    Returns Promise<string>

    A Promise for the evaluation result in JSON representation.

    -

evaluateFileMulti

  • evaluateFileMulti(filename): Promise<{
        [name: string]: string;
    }>

  • Evaluates a Jsonnet script in a file and returns a number of named JSON's.

    +

evaluateFileMulti

  • evaluateFileMulti(filename): Promise<{
        [name: string]: string;
    }>

  • Evaluates a Jsonnet script in a file and returns a number of named JSON's.

    Parameters

    • filename: string

      Path to the file.

    Returns Promise<{
        [name: string]: string;
    }>

    A Promise for the evaluation result in JSON representation.

    -

evaluateFileStream

  • evaluateFileStream(filename): Promise<string[]>

  • Evaluates a Jsonnet script in a file and returns a number of JSON's.

    +

evaluateFileStream

  • evaluateFileStream(filename): Promise<string[]>

  • Evaluates a Jsonnet script in a file and returns a number of JSON's.

    Parameters

    • filename: string

      Path to the file.

    Returns Promise<string[]>

    A Promise for the evaluation result in JSON representation.

    -

evaluateSnippet

  • evaluateSnippet(snippet, filename?): Promise<string>

  • Evaluates a Jsonnet script given as a string.

    +

evaluateSnippet

  • evaluateSnippet(snippet, filename?): Promise<string>

  • Evaluates a Jsonnet script given as a string.

    Parameters

    • snippet: string

      Jsonnet script to evaluate.

    • Optionalfilename: string

      Filename used for error reporting.

    Returns Promise<string>

    A Promise for the evaluation result in JSON representation.

    -

evaluateSnippetMulti

  • evaluateSnippetMulti(snippet, filename?): Promise<{
        [name: string]: string;
    }>

  • Evaluates a Jsonnet script given as a string and returns a number of named JSON's.

    +

evaluateSnippetMulti

  • evaluateSnippetMulti(snippet, filename?): Promise<{
        [name: string]: string;
    }>

  • Evaluates a Jsonnet script given as a string and returns a number of named JSON's.

    Parameters

    • snippet: string

      Jsonnet script to evaluate.

    • Optionalfilename: string

      Filename used for error reporting.

    Returns Promise<{
        [name: string]: string;
    }>

    A Promise for the evaluation result in JSON representation.

    -

evaluateSnippetStream

  • evaluateSnippetStream(snippet, filename?): Promise<string[]>

  • Evaluates a Jsonnet script given as a string and returns a number of JSON's.

    +

evaluateSnippetStream

  • evaluateSnippetStream(snippet, filename?): Promise<string[]>

  • Evaluates a Jsonnet script given as a string and returns a number of JSON's.

    Parameters

    • snippet: string

      Jsonnet script to evaluate.

    • Optionalfilename: string

      Filename used for error reporting.

    Returns Promise<string[]>

    A Promise for the evaluation result in JSON representation.

    -

extCode

  • extCode(key, value): this

  • Binds external variable named as key to a value represented by value.

    +

extCode

  • extCode(key, value): this

  • Binds external variable named as key to a value represented by value.

    Parameters

    • key: string

      Name of the external variable

    • value: string

      Code representation of the value to which the variable is bound

      -

    Returns this

extString

  • extString(key, value): this

  • Binds external variable named as key to string value.

    +

Returns this

extString

  • extString(key, value): this

  • Binds external variable named as key to string value.

    Parameters

    • key: string

      Name of the external variable

    • value: string

      String value to which the variable is bound

      -

    Returns this

maxGcGrowthTrigger

  • maxGcGrowthTrigger(value): this

  • Set the growth rate of the number of objects to trigger a garbage collection.

    +

Returns this

maxGcGrowthTrigger

maxGcMinObjects

Returns this

maxGcMinObjects

maxStack

Returns this

maxStack

maxTrace

Returns this

maxTrace

nativeCallback

Returns this

nativeCallback

stringOutput

stringOutput

tlaCode

Returns this

tlaCode

tlaString

Returns this

tlaString

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file diff --git a/master/classes/JsonnetError.html b/master/classes/JsonnetError.html index 2528863..ce1603b 100644 --- a/master/classes/JsonnetError.html +++ b/master/classes/JsonnetError.html @@ -1,2 +1,2 @@ -JsonnetError | @hanazuki/node-jsonnet

Class JsonnetError

Hierarchy

  • Error
    • JsonnetError

Constructors

constructor +JsonnetError | @hanazuki/node-jsonnet

Class JsonnetError

Hierarchy

  • Error
    • JsonnetError

Constructors

constructor

Constructors

constructor

  • new JsonnetError(message?): JsonnetError

  • Parameters

    • Optionalmessage: string

    Returns JsonnetError

Settings

Member Visibility

On This Page

Constructors
\ No newline at end of file diff --git a/master/types/JsonnetPrimitiveValue.html b/master/types/JsonnetPrimitiveValue.html index c85ef0c..2d689e7 100644 --- a/master/types/JsonnetPrimitiveValue.html +++ b/master/types/JsonnetPrimitiveValue.html @@ -1,2 +1,2 @@ JsonnetPrimitiveValue | @hanazuki/node-jsonnet

Type Alias JsonnetPrimitiveValue

JsonnetPrimitiveValue:
    | null
    | boolean
    | number
    | string

JsonnetPrimitiveValue is a class of values that may be passed to native callbacks.

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file