Class Instance

An instanec represents a collection of functions and configuration for the SQRL compiler and runtime

Hierarchy

Instance

Index

Properties

Methods

createPackageInstance getConfig importFromPackage listFunctions register registerCustom registerStatement registerSync registerTransform

Properties

`Private` config

config: Config

`Private` mergedConfig

mergedConfig: any = null

`Readonly` packageName

packageName: string = null

Methods

createPackageInstance

createPackageInstance(name: string): Instance
Parameters
- name: string
Returns Instance
- Defined in packages/sqrl/src/api/execute.ts:124

getConfig

getConfig(): Config
Returns Config
- Defined in packages/sqrl/src/api/execute.ts:140

importFromPackage

importFromPackage(name: string, importedPackage: any): Promise<void>
Parameters
- name: string
- importedPackage: any
Returns Promise<void>
- Defined in packages/sqrl/src/api/execute.ts:132

listFunctions

listFunctions(): FunctionInfo[]
Returns FunctionInfo[]
- Defined in packages/sqrl/src/api/execute.ts:155

register

register(func: ((state: Execution, ...args: any) => Promise<any>), options?: ImplementedFunctionOptions): void
Parameters
- func: ((state: Execution, ...args: any) => Promise<any>)
  - - (state: Execution, ...args: any): Promise<any>
    - Parameters
      
      state: Execution
      
      Rest ...args: any
      
      Returns Promise<any>
- options: ImplementedFunctionOptions = {}
Returns void
- Defined in packages/sqrl/src/api/execute.ts:169

registerCustom

registerCustom(transform: ((state: CompileState, ast: CustomCallAst) => Ast), options?: MinimalFunctionOptions): void
Parameters
- transform: ((state: CompileState, ast: CustomCallAst) => Ast)
  - - (state: CompileState, ast: CustomCallAst): Ast
    - Parameters
      
      state: CompileState
      
      ast: CustomCallAst
      
      Returns Ast
- options: MinimalFunctionOptions = {}
Returns void
- Defined in packages/sqrl/src/api/execute.ts:219

registerStatement

registerStatement(statementFeature: string, func: ((state: Execution, ...args: any) => Promise<any>), options?: ImplementedFunctionOptions): void
Parameters
- statementFeature: string
- func: ((state: Execution, ...args: any) => Promise<any>)
  - - (state: Execution, ...args: any): Promise<any>
    - Parameters
      
      state: Execution
      
      Rest ...args: any
      
      Returns Promise<any>
- options: ImplementedFunctionOptions = {}
Returns void
- Defined in packages/sqrl/src/api/execute.ts:200

registerSync

registerSync(func: ((...args: any) => any), options?: ImplementedFunctionOptions): void
Parameters
- func: ((...args: any) => any)
  - - (...args: any): any
    - Parameters
      
      Rest ...args: any
      
      Returns any
- options: ImplementedFunctionOptions = {}
Returns void
- Defined in packages/sqrl/src/api/execute.ts:185

registerTransform

registerTransform(transform: ((state: CompileState, ast: CallAst) => Ast), options?: FunctionOptions): void
Parameters
- transform: ((state: CompileState, ast: CallAst) => Ast)
  - - (state: CompileState, ast: CallAst): Ast
    - Parameters
      
      state: CompileState
      
      ast: CallAst
      
      Returns Ast
- options: FunctionOptions = {}
Returns void
- Defined in packages/sqrl/src/api/execute.ts:238

Class Instance

Hierarchy

Index

Properties

Methods

Properties

Private config

Private mergedConfig

Readonly packageName

Methods

createPackageInstance

Parameters

name: string

Returns Instance

getConfig

Returns Config

importFromPackage

Parameters

name: string

importedPackage: any

Returns Promise<void>

listFunctions

Returns FunctionInfo[]

register

Parameters

func: ((state: Execution, ...args: any) => Promise<any>)

Parameters

state: Execution

Rest ...args: any

Returns Promise<any>

options: ImplementedFunctionOptions = {}

Returns void

registerCustom

Parameters

transform: ((state: CompileState, ast: CustomCallAst) => Ast)

Parameters

state: CompileState

ast: CustomCallAst

Returns Ast

options: MinimalFunctionOptions = {}

Returns void

registerStatement

Parameters

statementFeature: string

func: ((state: Execution, ...args: any) => Promise<any>)

Parameters

state: Execution

Rest ...args: any

Returns Promise<any>

options: ImplementedFunctionOptions = {}

Returns void

registerSync

Parameters

func: ((...args: any) => any)

Parameters

Rest ...args: any

Returns any

options: ImplementedFunctionOptions = {}

Returns void

registerTransform

Parameters

transform: ((state: CompileState, ast: CallAst) => Ast)

Parameters

state: CompileState

ast: CallAst

Returns Ast

options: FunctionOptions = {}

Returns void

Settings

Member Visibility

Theme

`Private` config

`Private` mergedConfig

`Readonly` packageName

`Rest` ...args: any

`Rest` ...args: any

`Rest` ...args: any