KeyNode | parsekey

Type parameters

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

Hierarchy

Node<KEY>
- KeyNode

Index

Constructors

constructor

Properties

Accessors

parent

Methods

stringify

Constructors

constructor

new KeyNode<TValid, TNoteContent>(__namedParameters: { end: number; note?: { content: Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>; left: Token<boolean, NOTE_DELIM_RIGHT | NOTE_DELIM_LEFT, string, TOKEN_TYPE[]>; right: Token<boolean, NOTE_DELIM_RIGHT | NOTE_DELIM_LEFT, string, TOKEN_TYPE[]> }; start: number; value: Token<boolean, KEY, string, TOKEN_TYPE[]> }): KeyNode<TValid, TNoteContent>

Overrides Node.constructor
- Defined in src/ast/classes/KeyNode.ts:31
Type parameters
- TValid: boolean = boolean
- TNoteContent: Token<boolean, TOKEN_TYPE, string, TOKEN_TYPE[], TNoteContent> = Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>
Parameters
- __namedParameters: { end: number; note?: { content: Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>; left: Token<boolean, NOTE_DELIM_RIGHT | NOTE_DELIM_LEFT, string, TOKEN_TYPE[]>; right: Token<boolean, NOTE_DELIM_RIGHT | NOTE_DELIM_LEFT, string, TOKEN_TYPE[]> }; start: number; value: Token<boolean, KEY, string, TOKEN_TYPE[]> }
  - end: number
  - Optional note?: { content: Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>; left: Token<boolean, NOTE_DELIM_RIGHT | NOTE_DELIM_LEFT, string, TOKEN_TYPE[]>; right: Token<boolean, NOTE_DELIM_RIGHT | NOTE_DELIM_LEFT, string, TOKEN_TYPE[]> }
    - content: Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>
    - left: Token<boolean, NOTE_DELIM_RIGHT | NOTE_DELIM_LEFT, string, TOKEN_TYPE[]>
    - right: Token<boolean, NOTE_DELIM_RIGHT | NOTE_DELIM_LEFT, string, TOKEN_TYPE[]>
  - start: number
  - value: Token<boolean, KEY, string, TOKEN_TYPE[]>
Returns KeyNode<TValid, TNoteContent>

Properties

Readonly end

end: number

note

note: undefined | { content: TNoteContent; left: Token<boolean, NOTE_DELIM_RIGHT | NOTE_DELIM_LEFT, string, TOKEN_TYPE[]>; right: Token<boolean, NOTE_DELIM_RIGHT | NOTE_DELIM_LEFT, string, TOKEN_TYPE[]> }

Readonly start

start: number

Readonly type

type: KEY

Readonly valid

valid: boolean

value

value: Token<boolean, KEY, string, TOKEN_TYPE[]>

Accessors

parent

get parent(): undefined | ChainNode<boolean, Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>>
set parent(value: undefined | ChainNode<boolean, Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>>): void

Overrides Node.parent
- Defined in src/ast/classes/KeyNode.ts:23
Returns undefined | ChainNode<boolean, Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>>
Overrides Node.parent
- Defined in src/ast/classes/KeyNode.ts:26
Parameters
- value: undefined | ChainNode<boolean, Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>>
Returns void

Methods

stringify

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

Overrides Node.stringify
- Defined in src/ast/classes/KeyNode.ts:52
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

Type parameters

TValid: boolean = boolean

TNoteContent: Token = Token<boolean, NOTE_CONTENT>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

TValid: boolean = boolean

TNoteContent: Token<boolean, TOKEN_TYPE, string, TOKEN_TYPE[], TNoteContent> = Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>

Parameters

end: number

Optional note?: { content: Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>; left: Token<boolean, NOTE_DELIM_RIGHT | NOTE_DELIM_LEFT, string, TOKEN_TYPE[]>; right: Token<boolean, NOTE_DELIM_RIGHT | NOTE_DELIM_LEFT, string, TOKEN_TYPE[]> }

content: Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>

left: Token<boolean, NOTE_DELIM_RIGHT | NOTE_DELIM_LEFT, string, TOKEN_TYPE[]>

right: Token<boolean, NOTE_DELIM_RIGHT | NOTE_DELIM_LEFT, string, TOKEN_TYPE[]>

start: number

value: Token<boolean, KEY, string, TOKEN_TYPE[]>

Returns KeyNode<TValid, TNoteContent>

Properties

Readonly end

note

Readonly start

Readonly type

Readonly valid

value

Accessors

parent

Returns undefined | ChainNode<boolean, Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>>

Parameters

value: undefined | ChainNode<boolean, Token<boolean, NOTE_CONTENT, string, TOKEN_TYPE[]>>

Returns void

Methods

stringify

Parameters

opts: Pick<FullParserOptions<any, any>, "separators" | "keyNote">

Returns string