Class State

constructor

• new State(inData: string, options: Options, startPos?: number): State

  Parameters

  • inData: string
  • options: Options
  • startPos: number = 0

  Returns State

errors

Readonlyoptions

inLine

• get inLine(): number

  Current input line number

  Returns number

accept

• accept(what: string | RegExp): string

  Read and emit token(s). Returns undefined if not matched.

  Parameters

  • what: string | RegExp

  Returns string

• accept(...whats: (string | RegExp)[]): string[]

  Read and emit token(s). Returns undefined if not matched.

  Parameters

  • ...whats: (string | RegExp)[]

  Returns string[]

acceptType

• acceptType<T, A extends any[]>(func: (...args: A) => T, ...args: A): T

  Read and emit token only if not stripping types. Can also wrap a function call to strip its output when stripping types.

  Type Parameters

  • T
  • A extends any[]

  Parameters

  • func: (...args: A) => T
  • ...args: A

  Returns T

• acceptType(what: string | RegExp): string

  Read and emit token only if not stripping types. Can also wrap a function call to strip its output when stripping types.

  Parameters

  • what: string | RegExp

  Returns string

• acceptType(...whats: (string | RegExp)[]): string[]

  Read and emit token only if not stripping types. Can also wrap a function call to strip its output when stripping types.

  Parameters

  • ...whats: (string | RegExp)[]

  Returns string[]

clearTargetPos

• clearTargetPos(): void

  Clear the target position used for source mapping. Called after header parsing to ensure next token gets correct position.

  Returns void

emit

• emit(...args: (string | number | boolean)[]): void

  Emit output text. Automatically handles source mapping based on last read position. Numbers are treated as explicit position markers. false means the next arg should not have an automatic position emitted. true means the next arg should have an automatic position emitted, but it should not be used for source mapping, and the next token will get the same automatic position again.

  Parameters

  • ...args: (string | number | boolean)[]

  Returns void

getResult

• getResult(): {
      code: string;
      errors: ParseError[];
      map: { in: number[]; out: number[] };
  }

  Format the output tokens into a final string with proper whitespace.

  Returns { code: string; errors: ParseError[]; map: { in: number[]; out: number[] } }

hasMore

• hasMore(): boolean

  Check if more input remains to be parsed

  Returns boolean

justAfterNewLine

• justAfterNewLine(): boolean

  Check if we're at the start of a new line (for breaking operator processing).

  Returns boolean

lastNotSpace

• lastNotSpace(): boolean

  Check if the character before current position is not a space. Used to distinguish function calls foo(x) from spaced expressions foo (x).

  Returns boolean

must

• must<T extends string | true>(result: false | T | (() => false | T)): T

  Require a value to be truthy, throwing ParseError otherwise.

  Type Parameters

  • T extends string | true

  Parameters

  • result: false | T | (() => false | T)

  Returns T

outputEndsWith

• outputEndsWith(str: string): boolean

  Check if the last emitted output ends with the given string. Useful for conditionally emitting closing tokens.

  Parameters

  • str: string

  Returns boolean

parseGroup

• parseGroup(opts: ParseGroupOpts, itemFunc: () => boolean): boolean

  Parse a group with optional delimiters and separators.

  Parameters

  • opts: ParseGroupOpts
  • itemFunc: () => boolean

  Returns boolean

peek

• peek(...whats: (string | RegExp)[]): any

  Peek at token(s) without consuming them.

  Parameters

  • ...whats: (string | RegExp)[]

  Returns any

read

• read(what: string | RegExp): string

  Read token(s) from input, consuming them. Returns undefined if not matched. RegExp arguments must have the /y (sticky) flag.

  Parameters

  • what: string | RegExp

  Returns string

• read(...whats: (string | RegExp)[]): string[]

  Read token(s) from input, consuming them. Returns undefined if not matched. RegExp arguments must have the /y (sticky) flag.

  Parameters

  • ...whats: (string | RegExp)[]

  Returns string[]

readNewline

• readNewline(): boolean

  Read a newline token (including handling indent changes). This is public because the Main parser loop needs it.

  Returns boolean

recoverErrors

• recoverErrors(func: () => any): any

  Attempt to recover from errors during parsing.

  Parameters

  • func: () => any

  Returns any

snapshot

• snapshot(): Snapshot

  Create a snapshot of current state that can be reverted later.

  Returns Snapshot