Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TokenInfo

Package version

Information about a token returned by an analyzer.

Hierarchy

  • TokenInfo

Index

Properties

Optional endOffset

endOffset: undefined | number

The index of the last character of the token in the input text. NOTE: This property will not be serialized. It can only be populated by the server.

Optional position

position: undefined | number

The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startOffset

startOffset: undefined | number

The index of the first character of the token in the input text. NOTE: This property will not be serialized. It can only be populated by the server.

Optional token

token: undefined | string

The token returned by the analyzer. NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc