Class Encoda

Hierarchy

  • Jesta
    • Encoda

Constructors

constructor

Properties

build call clean cli compile convert decode delete dispatch downcast encode enrich execute export funcs get import pipe pull read select serve set upcast validate vars write

Methods

manifest

Constructors

constructor

  • Returns Encoda

Properties

build

build: ((this, node, force) => Promise<Node>)

Type declaration

    • (this, node, force): Promise<Node>

    • Build a document

      This implementation walks the document and collects NPM package names from the imports property of Javascript CodeChunk nodes. It then calls npm install with the names of the packages missing from package.json. If there is no package.json file then will create one.

      Parameters

      • this: Jesta
      • node: Node
      • force: boolean

      Returns Promise<Node>

call

call: ((this, name, args) => Promise<Node>)

Type declaration

    • (this, name, args): Promise<Node>

    • Call a function within a document.

      Parameters

      • this: Jesta
      • name: string

        The name of the function

      • args: Record<string, Node>

        Arguments to call the document or function with

      Returns Promise<Node>

clean

clean: ((this, node) => Promise<Node>)

Type declaration

    • (this, node): Promise<Node>

    • Parameters

      • this: Jesta
      • node: Node

      Returns Promise<Node>

cli

cli: ((this) => void)

Type declaration

    • (this): void

    • Expose a command line interface for the plugin.

      The command line interface is intended to be simple and mainly for use by plugin developers and users that want to use plugins standalone.

      Note: This function is a simple wrapper around the run function that passes it the args vector and exits on error.

      Parameters

      • this: Jesta

      Returns void

compile

compile: ((this, node, force) => Promise<Node>)

Type declaration

    • (this, node, force): Promise<Node>

    • Parameters

      • this: Jesta
      • node: Node
      • force: boolean

      Returns Promise<Node>

convert

convert: typeof convert = convert_

decode

decode: typeof decode = decode

delete

delete: ((this, name) => Promise<undefined>)

Type declaration

    • (this, name): Promise<undefined>

    • Parameters

      • this: Jesta
      • name: string

      Returns Promise<undefined>

dispatch

dispatch: ((this, method, params) => Promise<Node | undefined>)

Type declaration

    • (this, method, params): Promise<Node | undefined>

    • Parameters

      • this: Jesta
      • method: string
      • params: Record<string, undefined | Node>

      Returns Promise<Node | undefined>

downcast

downcast: ((this, node) => Promise<Node>)

Type declaration

    • (this, node): Promise<Node>

    • Parameters

      • this: Jesta
      • node: Node

      Returns Promise<Node>

encode

encode: typeof encode = encode

enrich

enrich: ((this, node, force?) => Promise<Node>)

Type declaration

    • (this, node, force?): Promise<Node>

    • Parameters

      • this: Jesta
      • node: Node
      • Optional force: boolean

      Returns Promise<Node>

execute

execute: ((this, node, force) => Promise<Node>)

Type declaration

    • (this, node, force): Promise<Node>

    • Parameters

      • this: Jesta
      • node: Node
      • force: boolean

      Returns Promise<Node>

export

export: ((this, node, output, format?, downcast?, validate?, theme?) => Promise<string>)

Type declaration

    • (this, node, output, format?, downcast?, validate?, theme?): Promise<string>

    • Parameters

      • this: Jesta
      • node: Node
      • output: string
      • Optional format: string
      • Optional downcast: boolean
      • Optional validate: boolean
      • Optional theme: string

      Returns Promise<string>

funcs

funcs: ((this) => Promise<Record<string, string>>)

Type declaration

    • (this): Promise<Record<string, string>>

    • List functions of the current document.

      Returns a map of the name and type signature of the current document's functions. See vars for an analogous method returning variables and their types.

      Parameters

      • this: Jesta

      Returns Promise<Record<string, string>>

get

get: typeof get

import

import: typeof import_

pipe

pipe: ((this, node, calls) => Promise<Node>)

Type declaration

    • (this, node, calls): Promise<Node>

    • Parameters

      • this: Jesta
      • node: Node
      • calls: Method[]

      Returns Promise<Node>

pull

pull: typeof pull

read

read: typeof read

select

select: typeof select

serve

serve: ((this) => Promise<void>)

Type declaration

    • (this): Promise<void>

    • Serve the plugin.

      Parameters

      • this: Jesta

      Returns Promise<void>

set

set: typeof set

upcast

upcast: ((this, node) => Promise<Node>)

Type declaration

    • (this, node): Promise<Node>

    • Parameters

      • this: Jesta
      • node: Node

      Returns Promise<Node>

validate

validate: typeof validate

vars

vars: ((this) => Promise<Record<string, string>>)

Type declaration

    • (this): Promise<Record<string, string>>

    • List variables of the current document.

      Returns a map of the name and type of the current document's variables. See funcs for an analogous method returning functions and their type signature.

      Parameters

      • this: Jesta

      Returns Promise<Record<string, string>>

write

write: typeof write

Methods

manifest

  • Returns Manifest

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc