Class ASTNode<T>

Type Parameters

Hierarchy

ASTNode

Index

Constructors

constructor

new ASTNode<T>(p: Partial<Pick<ASTNode<T>, "error" | "text" | "children" | "parent" | "data" | "$">> & Pick<ASTNode<T>, "type" | "start"> & {
traverser?: Traverser<T>;
}): ASTNode<T>
Type Parameters
- T
Parameters
- p: Partial<Pick<ASTNode<T>, "error" | "text" | "children" | "parent" | "data" | "$">> & Pick<ASTNode<T>, "type" | "start"> & {
  traverser?: Traverser<T>;
  }
Returns ASTNode<T>
- Defined in src/parser/ast.ts:41

Properties

`Readonly` $

$: ASTNodeQuerySelector<T>

Find AST node by its type name or literal value.

`Optional` `Readonly` children

children?: readonly ASTNode<T>[]

NT's children.

`Optional` data

data?: T

`Optional` error

error?: any

`Optional` parent

parent?: ASTNode<T>

Parent must be an NT unless this node is the root node, in this case parent is null.

`Readonly` start

start: number

Start position of the input string. Same as the first token's start position.

`Private` `Optional` str

str?: string

Cache the string representation.

`Optional` `Readonly` text

text?: string

T's text content.

`Private` `Optional` traverser

traverser?: Traverser<T>

traverser shouldn't be exposed because we want users to use traverse instead of traverser directly.

`Readonly` type

type: string

T's or NT's name.

Methods

toObj

toObj(): ASTObj
Return an ASTObj for serialization.

Returns ASTObj
- Defined in src/parser/ast.ts:83

toString

toString(): string
Return type name. If the type is anonymous, return "literal value".

Returns string
- Defined in src/parser/ast.ts:78

toTreeString

toTreeString(options?: {
    anonymous?: string;
    indent?: string;
    initialIndent?: string;
}): string
Return a tree-structured string.
Parameters
- Optional options: {
      anonymous?: string;
      indent?: string;
      initialIndent?: string;
  }
  - Optional anonymous?: string
  - Optional indent?: string
  - Optional initialIndent?: string
Returns string
- Defined in src/parser/ast.ts:55

traverse

traverse(): undefined | T
Try to use the traverser to calculate data and return the data.

Returns undefined | T
- Defined in src/parser/ast.ts:93

`Static` from

from<T>(t: Readonly<Token>): ASTNode<T>
Type Parameters
- T
Parameters
- t: Readonly<Token>
Returns ASTNode<T>
- Defined in src/parser/ast.ts:50

Class ASTNode<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

Parameters

p: Partial<Pick<ASTNode<T>, "error" | "text" | "children" | "parent" | "data" | "$">> & Pick<ASTNode<T>, "type" | "start"> & { traverser?: Traverser<T>; }

Returns ASTNode<T>

Properties

Readonly $

Optional Readonly children

Optional data

Optional error

Optional parent

Readonly start

Private Optional str

Optional Readonly text

Private Optional traverser

Readonly type

Methods

toObj

Returns ASTObj

toString

Returns string

toTreeString

Parameters

Optional options: { anonymous?: string; indent?: string; initialIndent?: string; }

Optional anonymous?: string

Optional indent?: string

Optional initialIndent?: string

Returns string

traverse

Returns undefined | T

Static from

Type Parameters

T

Parameters

t: Readonly<Token>

Returns ASTNode<T>

Settings

Member Visibility

Theme

p: Partial<Pick<ASTNode<T>, "error" | "text" | "children" | "parent" | "data" | "$">> & Pick<ASTNode<T>, "type" | "start"> & {
traverser?: Traverser<T>;
}

`Readonly` $

`Optional` `Readonly` children

`Optional` data

`Optional` error

`Optional` parent

`Readonly` start

`Private` `Optional` str

`Optional` `Readonly` text

`Private` `Optional` traverser

`Readonly` type

`Optional` options: {
anonymous?: string;
indent?: string;
initialIndent?: string;
}

`Optional` anonymous?: string

`Optional` indent?: string

`Optional` initialIndent?: string

`Static` from