Class TokenObj

constructor

• new TokenObj(type: TokenType, text: string): TokenObj

• Contructs a new token value.

  Parameters

  • type: TokenType

    The token type.
  • text: string

    The token's text.

  Returns TokenObj

Readonly_isATokenObj

Readonlytext

Readonlytype

paths

• get paths(): string[]

• Returns string[]

  The text value as a paths array.

equals

• equals(token: Token): boolean

• Returns true if the object matches this one.

  Parameters

  • token: Token

  Returns boolean

  True if the objects are equal.

is

• is(type: TokenType): 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]: HaysonVal | string[] }

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

  A JSON representation of the token.

toString

• toString(): string

• Returns string

  A string representation of the token.