Class StringTokenParserExperimental

constructor

• new StringTokenParser(source: string): StringTokenParser
  Experimental

  Parameters

  • source: string

    The source string to be parsed.

  Returns StringTokenParser

Experimentalposition

Readonly Experimentalsource

isEof

• get isEof(): boolean
  Experimental

  Indicates whether the parser has reached the end of the source string.

  Returns boolean

  true if the current position is at or beyond the end of the source; otherwise, false.

acceptState

• acceptState(): void
  Experimental

  Removes the last saved position from the state stack without restoring it.

  Returns void

  Throws

  If the state stack is empty.

checkStateStackEmpty

• checkStateStackEmpty(): void
  Experimental

  Checks if the state stack is empty. Throws an Error if not.

  Returns void

  Throws

  If the state stack is not empty.

  Remarks

  This method is useful for ensuring that all states have been accepted or popped before finalizing the parsing process.

  See

  pushState

consumeAnyString

• consumeAnyString(
      needles: Iterable<string>,
      comparer?: EqualityComparer<any>,
  ): undefined | string
  Experimental

  Consumes the first matching string from the provided iterable if it matches the current position. Advances the position if a match is found.

  Parameters

  • needles: Iterable<string>

    One or more strings to match.
  • Optionalcomparer: EqualityComparer<any>

    An optional equality comparer for custom string comparison.

  Returns undefined | string

  The matched string if successful; otherwise, undefined.

consumeRegExp

• consumeRegExp(needle: RegExp): undefined | RegExpExecArray | RegExpMatchArray
  Experimental

  Consumes a regular expression match at the current position in the source. Advances the position if the match is successful.

  Parameters

  • needle: RegExp

    The regular expression to match. Must include the y (sticky) flag.

  Returns undefined | RegExpExecArray | RegExpMatchArray

  The match result if successful; otherwise, undefined.

consumeString

• consumeString(needle: string, comparer?: EqualityComparer<any>): boolean
  Experimental

  Consumes the specified string if it matches the current position in the source. Advances the position if the match is successful.

  Parameters

  • needle: string

    The string to match.
  • Optionalcomparer: EqualityComparer<any>

    An optional equality comparer for custom string comparison.

  Returns boolean

  true if the string was successfully consumed; otherwise, false.

peekAnyString

• peekAnyString(
      needles: Iterable<string>,
      comparer?: EqualityComparer<any>,
  ): undefined | string
  Experimental

  Checks if any of the provided strings match the current position in the source without consuming it.

  Parameters

  • needles: Iterable<string>

    One or more strings to match.
  • Optionalcomparer: EqualityComparer<any>

    An optional equality comparer for custom string comparison.

  Returns undefined | string

  The matched string if successful; otherwise, undefined.

peekRegExp

• peekRegExp(needle: RegExp): undefined | RegExpExecArray | RegExpMatchArray
  Experimental

  Checks if a regular expression matches the current position in the source without consuming it.

  Parameters

  • needle: RegExp

    The regular expression to match. Must include the y (sticky) flag.

  Returns undefined | RegExpExecArray | RegExpMatchArray

  The match result if successful; otherwise, undefined.

peekString

• peekString(needle: string, comparer?: EqualityComparer<any>): boolean
  Experimental

  Checks if the specified string matches the current position in the source without consuming it.

  Parameters

  • needle: string

    The string to match.
  • Optionalcomparer: EqualityComparer<any>

    An optional equality comparer for custom string comparison.

  Returns boolean

  true if the string matches; otherwise, false.

popState

• popState(): void
  Experimental

  Restores the last saved position from the state stack. This backtracks the parser to the last saved state.

  Returns void

  Throws

  If the state stack is empty.

  See

  • pushState
  • acceptState

pushState

• pushState(): void
  Experimental

  Saves the current position in the source to the state stack.

  Returns void

  See

  • acceptState
  • popState
  • checkStateStackEmpty