Class NodeType

constructor

• new NodeType(): NodeType

  Returns NodeType

Readonlyid

Readonlyname

Staticnone

isAnonymous

• get isAnonymous(): boolean

  When true, this node type doesn't correspond to a user-declared named node, for example because it is used to cache repetition.

  Returns boolean

isError

• get isError(): boolean

  Indicates whether this is an error node.

  Returns boolean

isSkipped

• get isSkipped(): boolean

  True when this node is produced by a skip rule.

  Returns boolean

isTop

• get isTop(): boolean

  True when this is the top node of a grammar.

  Returns boolean

is

• is(name: string | number): boolean

  Returns true when this node's name or one of its groups matches the given string.

  Parameters

  • name: string | number

  Returns boolean

prop

• prop<T>(prop: NodeProp<T>): T

  Retrieves a node prop for this type. Will return undefined if the prop isn't present on this node.

  Type Parameters

  • T

  Parameters

  • prop: NodeProp<T>

  Returns T

Staticdefine

• define(
      spec: {
          error?: boolean;
          id: number;
          name?: string;
          props?: readonly ([NodeProp<any>, any] | NodePropSource)[];
          skipped?: boolean;
          top?: boolean;
      },
  ): NodeType

  Define a node type.

  Parameters

  • spec: {
        error?: boolean;
        id: number;
        name?: string;
        props?: readonly ([NodeProp<any>, any] | NodePropSource)[];
        skipped?: boolean;
        top?: boolean;
    }

    • Optionalerror?: boolean

      Whether this node counts as an error node.

    • id: number

      The ID of the node type. When this type is used in a set, the ID must correspond to its index in the type array.

    • Optionalname?: string

      The name of the node type. Leave empty to define an anonymous node.

    • Optionalprops?: readonly ([NodeProp<any>, any] | NodePropSource)[]

      Node props to assign to the type. The value given for any given prop should correspond to the prop's type.

    • Optionalskipped?: boolean

      Whether this node is a skipped node.

    • Optionaltop?: boolean

      Whether this is a top node.

  Returns NodeType

Staticmatch

• match<T>(map: { [selector: string]: T }): (node: NodeType) => T

  Create a function from node types to arbitrary values by specifying an object whose property names are node or group names. Often useful with NodeProp.add. You can put multiple names, separated by spaces, in a single property name to map multiple node names to a single value.

  Type Parameters

  • T

  Parameters

  • map: { [selector: string]: T }

  Returns (node: NodeType) => T