Class ChainNode<TValid, TNoteContent>

Type parameters

TValid: boolean = boolean
TNoteContent: Token = Token<boolean, NOTE_CONTENT>

Hierarchy

Node<CHAIN>
- ChainNode

Index

Constructors

constructor

Properties

Accessors

parent

Methods

stringify

Constructors

constructor

new ChainNode<TValid, TNoteContent>(__namedParameters: { combos: ComboNode<boolean, TNoteContent>[]; end: number; start: number }): ChainNode<TValid, TNoteContent>

Overrides Node.constructor
- Defined in src/ast/classes/ChainNode.ts:24
Type parameters
- TValid: boolean = boolean
- TNoteContent: Token<boolean, TOKEN_TYPE, string, TOKEN_TYPE[], TNoteContent> = Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>
Parameters
- __namedParameters: { combos: ComboNode<boolean, TNoteContent>[]; end: number; start: number }
  - combos: ComboNode<boolean, TNoteContent>[]
  - end: number
  - start: number
Returns ChainNode<TValid, TNoteContent>

Properties

Readonly combos

combos: ComboNode<boolean, TNoteContent>[]

Readonly end

end: number

Readonly start

start: number

Readonly type

type: CHAIN

Readonly valid

valid: boolean

Accessors

parent

get parent(): undefined
set parent(value: undefined): void

Overrides Node.parent
- Defined in src/ast/classes/ChainNode.ts:16
Returns undefined
Overrides Node.parent
- Defined in src/ast/classes/ChainNode.ts:19
Parameters
- value: undefined
Returns void

Methods

stringify

stringify(opts: Pick<FullParserOptions<any, any>, "separators" | "keyNote">): string

Overrides Node.stringify
- Defined in src/ast/classes/ChainNode.ts:36
Returns the canonical version string version of the node.

The main purpose is to provide some definitive string versions of nodes so that we can check the equality of two shortcuts. This should ideally be done at the ChainNode level since e.g. key parses to Chain(Combo(Key(key))) but all it's node's string versions equal each other (i.e. Chain(Combo(Key(key))) === Key(key)).

The string returned should also parse back to exactly the same nodes (again, at the @ChainNode level).

See Token.stringify for how this works at the token level.

Parameters
- opts: Pick<FullParserOptions<any, any>, "separators" | "keyNote">
Returns string

Generated using TypeDoc