Class TokenObj

constructor

• new TokenObj(type, text): TokenObj

• Contructs a new token value.

  Parameters

  • type: TokenType

    The token type.

  • text: string

    The token's text.

  Returns TokenObj

Readonly _isATokenObj

Readonly text

Readonly type

paths

• get paths(): string[]

• Returns string[]

  The text value as a paths array.

equals

• equals(token): boolean

• Returns true if the object matches this one.

  Parameters

  • token: Token

  Returns boolean

  True if the objects are equal.

is

• is(type): boolean

• Returns true if the type matches this token's type.

  Parameters

  • type: TokenType

    The token type.

  Returns boolean

  True if the type matches.

toFilter

• toFilter(): string

• Returns string

  The encoded value that can be used in a haystack filter.

toJSON

• toJSON(): {
      type: string;
      [prop: string]: string | string[] | HaysonVal;
  }

• Returns {
      type: string;
      [prop: string]: string | string[] | HaysonVal;
  }

  A JSON representation of the token.

  • [prop: string]: string | string[] | HaysonVal

  • type: string

toString

• toString(): string

• Returns string

  A string representation of the token.