Class Reader

constructor

• new Reader(data?: any, cursor?: any, opts?: {}): Reader

  Parameters

  • Optionaldata: any
  • Optionalcursor: any
  • Optionalopts: {}

  Returns Reader

_dir

_document

_lines

_lookAhead

_mark

_saved

_unescapeNextLine

file

lineno

path

processLines

sourceLines

unterminated

cursor

• get cursor(): Cursor

  Returns Cursor

lines

• get lines(): string[]

  Returns the remaining lines in forward order (first remaining line at index 0). The returned object is a mutable proxy so that element assignments like reader.lines[i] = newValue are reflected back into the internal reversed stack.

  Returns string[]

logger

• get logger(): any

  Returns any

_logError

• _logError(msg: any, opts?: {}): void

  Parameters

  • msg: any
  • Optionalopts: {}

  Returns void

_logInfo

• _logInfo(msg: string, opts?: { sourceLocation?: any }): void

  Parameters

  • msg: string
  • Optionalopts: { sourceLocation?: any }

  Returns void

_logWarn

• _logWarn(
      msg: string,
      opts?: { includeLocation?: any; sourceLocation?: any },
  ): void

  Parameters

  • msg: string
  • Optionalopts: { includeLocation?: any; sourceLocation?: any }

  Returns void

advance

• advance(): Promise<boolean>

  Returns Promise<boolean>

createLogMessage

• createLogMessage(text: any, context?: {}): any

  Parameters

  • text: any
  • Optionalcontext: {}

  Returns any

cursorAtLine

• cursorAtLine(lineno: any): Cursor

  Parameters

  • lineno: any

  Returns Cursor

cursorAtMark

• cursorAtMark(): Cursor

  Returns Cursor

cursorAtPrevLine

• cursorAtPrevLine(): Cursor

  Returns Cursor

cursorBeforeMark

• cursorBeforeMark(): Cursor

  Returns Cursor

discardSave

• discardSave(): void

  Returns void

empty

• empty(): boolean | Promise<boolean>

  Returns boolean | Promise<boolean>

eof

• eof(): boolean | Promise<boolean>

  Returns boolean | Promise<boolean>

getCursor

• getCursor(): Cursor

  Returns Cursor

getLines

• getLines(): string[]

  Returns string[]

getLogger

• getLogger(): any

  Returns any

getString

• getString(): string

  Returns string

hasMoreLines

• hasMoreLines(): boolean | Promise<boolean>

  Returns boolean | Promise<boolean>

isNextLineEmpty

• isNextLineEmpty(): Promise<boolean>

  Returns Promise<boolean>

lineInfo

• lineInfo(): string

  Returns string

mark

• mark(): void

  Returns void

nextLineEmpty

• nextLineEmpty(): Promise<boolean>

  Returns Promise<boolean>

peekLine

• peekLine(direct?: boolean): Promise<string>

  Peek at the next line without consuming it.

  Parameters

  • Optionaldirect: boolean

    When true, bypass processLine and return the raw stack top.

  Returns Promise<string>

  The next line, or undefined if there are no more lines.

peekLines

• peekLines(num?: number, direct?: boolean): Promise<string[]>

  Peek at the next num lines without consuming them.

  Parameters

  • Optionalnum: number
  • Optionaldirect: boolean

  Returns Promise<string[]>

read

• read(): Promise<string>

  Returns Promise<string>

readLine

• readLine(): Promise<string>

  Returns Promise<string>

readlines

• readlines(): Promise<string[]>

  Returns Promise<string[]>

readLines

• readLines(): Promise<string[]>

  Returns Promise<string[]>

readLinesUntil

• readLinesUntil(
      options?: {
          breakOnBlankLines?: boolean;
          breakOnListContinuation?: boolean;
          context?: string;
          cursor?: Cursor;
          preserveLastLine?: boolean;
          readLastLine?: boolean;
          skipFirstLine?: boolean;
          skipLineComments?: boolean;
          skipProcessing?: boolean;
          terminator?: string;
      },
      filter?: Function,
  ): Promise<string[]>

  Read lines until a termination condition is met.

  Parameters

  • Optionaloptions: {
        breakOnBlankLines?: boolean;
        breakOnListContinuation?: boolean;
        context?: string;
        cursor?: Cursor;
        preserveLastLine?: boolean;
        readLastLine?: boolean;
        skipFirstLine?: boolean;
        skipLineComments?: boolean;
        skipProcessing?: boolean;
        terminator?: string;
    }

    • OptionalbreakOnBlankLines?: boolean

      Stop on blank lines.

    • OptionalbreakOnListContinuation?: boolean

      Stop on a list continuation (+).

    • Optionalcontext?: string

      Name used in unterminated-block warnings.

    • Optionalcursor?: Cursor

      Starting cursor for unterminated-block warnings.

    • OptionalpreserveLastLine?: boolean

      Push the terminating line back.

    • OptionalreadLastLine?: boolean

      Include the terminating line in result.

    • OptionalskipFirstLine?: boolean

      Skip the first line before scanning.

    • OptionalskipLineComments?: boolean

      Skip line comments.

    • OptionalskipProcessing?: boolean

      Disable line preprocessing for this call.

    • Optionalterminator?: string

      Line at which to stop.

  • Optionalfilter: Function

    Optional function(line) returning true to break.

  Returns Promise<string[]>

replaceLine

• replaceLine(replacement: any): boolean

  Parameters

  • replacement: any

  Returns boolean

replaceNextLine

• replaceNextLine(replacement: any): boolean

  Parameters

  • replacement: any

  Returns boolean

restoreLine

• restoreLine(lineToRestore: any): void

  Parameters

  • lineToRestore: any

  Returns void

restoreLines

• restoreLines(linesToRestore: any): void

  Parameters

  • linesToRestore: any

  Returns void

restoreSave

• restoreSave(): void

  Returns void

save

• save(): void

  Returns void

skipBlankLines

• skipBlankLines(): Promise<number>

  Returns Promise<number>

skipCommentLines

• skipCommentLines(): Promise<void>

  Returns Promise<void>

skipLineComments

• skipLineComments(): Promise<string[]>

  Returns Promise<string[]>

source

• source(): string

  Returns string

string

• string(): string

  Returns string

terminate

• terminate(): void

  Returns void

toString

• toString(): string

  Returns string

unshiftLine

• unshiftLine(lineToRestore: any): void

  Parameters

  • lineToRestore: any

  Returns void

unshiftLines

• unshiftLines(linesToRestore: any): void

  Parameters

  • linesToRestore: any

  Returns void