Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ComboNode<TValid, TNoteContent>

Type parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new ComboNode<TValid, TNoteContent>(__namedParameters: { end: number; keys: KeyNode<boolean, TNoteContent>[]; seps: Token<boolean, SEPARATOR, string, TOKEN_TYPE[]>[]; start: number }): ComboNode<TValid, TNoteContent>

Properties

Readonly end

end: number

Readonly keys

keys: KeyNode<boolean, TNoteContent>[]

Readonly seps

seps: Token<boolean, SEPARATOR, string, TOKEN_TYPE[]>[]

The separators. They're always valid.

Readonly start

start: number

Readonly type

type: COMBO

Readonly valid

valid: boolean

Accessors

firstKey

  • get firstKey(): KeyNode<boolean, TNoteContent>

firstValidKey

  • get firstValidKey(): undefined | Token<true, KEY, string, never>

lastKey

  • get lastKey(): KeyNode<boolean, TNoteContent>

lastValidKey

  • get lastValidKey(): undefined | KeyNode<true, TNoteContent>

parent

Methods

stringify

  • 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

    Returns string

Generated using TypeDoc