Language | turingjs

Type parameters

Hierarchy

Language

Index

Constructors

constructor

Properties

executionStateStore

Methods

Constructors

constructor

new Language(): Language
new Language(baseLanguage: Language<T>): Language

- Defined in language.ts:5
Creates an instance of Language.

memberof

Language

Returns Language
- Defined in language.ts:11
Creates an instance of Language that is a clone of baseLanguage.

memberof

Language

Parameters
- baseLanguage: Language<T>
Returns Language

Properties

Private executionStateStore

executionStateStore: ExecutionState<T>

Methods

data

data(data: Partial<T>): Language<T>
data<K>(key: K, value: T[K]): Language<T>

- Defined in language.ts:80
Takes an object to be appended to the data object of the state

memberof

Language

Parameters
- data: Partial<T>
Returns Language<T>
- Defined in language.ts:91
Takes a key-value pair to be injected into the data object of the state object

template

K

memberof

Language

Type parameters
- K: keyof T
Parameters
- key: K
- value: T[K]
Returns Language<T>

on

on(events: EventHandlers<T>): Language<T>
on(event: "eof" | "unexpectedToken", handler: EventHandler<T>): Language<T>

- Defined in language.ts:110
memberof

Language

Parameters
- events: EventHandlers<T>
Returns Language<T>
- Defined in language.ts:118
memberof

Language

Parameters
- event: "eof" | "unexpectedToken"
- handler: EventHandler<T>
Returns Language<T>

run

run(program: string): Promise<IState<T>>
run(program: string, onSuccess: function, onError?: function): void

- Defined in language.ts:139
Takes a string of code and runs it asynchronously

memberof

Language

Parameters
- program: string
Returns Promise<IState<T>>
- Defined in language.ts:149
Takes a string of code and runs it synchronously

memberof

Language

Parameters
- program: string
- onSuccess: function
  - - (finalState: IState<T>): void
    - Parameters
      - finalState: IState<T>
      Returns void
- Optional onError: function
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns void

token

token(tokens: TokenHandlers<T>): Language<T>
token(token: string, handler: TokenHandler<T>): Language<T>
token(unexpectedTokenHandler: TokenHandler<T>): Language<T>

- Defined in language.ts:35
Takes an object where every key is a token-string and every value is the handler for its key

memberof

Language

Parameters
- tokens: TokenHandlers<T>
Returns Language<T>
- Defined in language.ts:45
Takes a token-string and a function to handle occurrences of the token in code

memberof

Language

Parameters
- token: string
- handler: TokenHandler<T>
Returns Language<T>
- Defined in language.ts:54
Alias for .on('unexpectedToken', handler);

memberof

Language

Parameters
- unexpectedTokenHandler: TokenHandler<T>
Returns Language<T>

Type parameters

T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Language

Parameters

baseLanguage: Language<T>

Returns Language

Properties

Private executionStateStore

Methods

data

Parameters

data: Partial<T>

Returns Language<T>

Type parameters

K: keyof T

Parameters

key: K

value: T[K]

Returns Language<T>

on

Parameters

events: EventHandlers<T>

Returns Language<T>

Parameters

event: "eof" | "unexpectedToken"

handler: EventHandler<T>

Returns Language<T>

run

Parameters

program: string

Returns Promise<IState<T>>

Parameters

program: string

onSuccess: function

Parameters

finalState: IState<T>

Returns void

Optional onError: function

Parameters

error: Error

Returns void

Returns void

token

Parameters

tokens: TokenHandlers<T>

Returns Language<T>

Parameters

token: string

handler: TokenHandler<T>

Returns Language<T>

Parameters

unexpectedTokenHandler: TokenHandler<T>

Returns Language<T>