Class StringReader

constructor

• new StringReader(data): StringReader

• Parameters

  • data: string

    The string to read.

  Returns StringReader

data

position

length

• get length(): number

• Returns the length of data.

  Returns number

peek

• get peek(): number

• Returns the character at the current position without advancing the cursor.

  Note: This method has no bounds checking; if position is greater than or equal to str.length then NaN will be returned.

  Returns number

  See

  String.charCodeAt

remaining

• get remaining(): number

• Returns the number of characters remaining to be read.

  Returns number

charIf

• charIf(charCode): boolean

• If peek equals the given character code, returns true and advances the index by one.

  Parameters

  • charCode: number

  Returns boolean

err

• err(message, offset?): never

• Throws a StringParseError where the location uses printStringPosition to show a friendly message indicating the current position.

  Parameters

  • message: string
  • offset: number = 0

    The offset to add to the current position.

  Returns never

hasNext

• hasNext(): boolean

• Returns true if the current position is less than the source data's length.

  Returns boolean

next

• next(): number

• Reads and returns the character code at the current position. To read the next character without advancing the cursor, use peek

  Note: This method has no bounds checking; if position is greater than or equal to str.length then NaN will be returned and position will still be incremented.

  Returns number

  See

  String.charCodeAt

read

• read(str, ignoreCase?): string

• Reads the expected string from the current position. If the read string doesn't match the given string, a StringParseError is thrown.

  Parameters

  • str: string

    The string required to match at the current position.
  • ignoreCase: boolean = false

    If true, the comparison will be case-insensitive.

  Returns string

readChar

• readChar(charCode): number

• Reads the expected char code from the current position. If the read character doesn't match the given character, a StringParseError is thrown.

  Parameters

  • charCode: number

    The character code required to match at the current position.

  Returns number

stringIf

• stringIf(string, ignoreCase?): boolean

• If the given string matches the substring at the current position, returns true and advances the index by the string's length.

  Parameters

  • string: string
  • ignoreCase: boolean = false

  Returns boolean

substr

• substr(length): string

• Reads the substring from the current index with the given length.

  Parameters

  • length: number

  Returns string

substringUntil

• substringUntil(predicate): string

• The same as until except returns the read substring as a result.

  Parameters

  • predicate: ((charCode: number) => boolean)
    • • (charCode): boolean

      • Parameters

        • charCode: number

        Returns boolean

  Returns string

substringUntilChar

• substringUntilChar(charCode): string

• The same as untilChar except returns the read substring as a result.

  Parameters

  • charCode: number

  Returns string

substringWhile

• substringWhile(predicate): string

• The same as while except returns the read substring as a result.

  Parameters

  • predicate: ((charCode: number) => boolean)
    • • (charCode): boolean

      • Parameters

        • charCode: number

        Returns boolean

  Returns string

until

• until(predicate): number

• Reads characters until the predicate returns true or the string length has been reached.

  Parameters

  • predicate: ((charCode: number) => boolean)
    • • (charCode): boolean

      • Parameters

        • charCode: number

        Returns boolean

  Returns number

  number Returns the start index.

untilChar

• untilChar(charCode): number

• Reads characters until the given character has been found or the string length has been reached.

  Parameters

  • charCode: number

  Returns number

  number Returns the start index.

untilString

• untilString(string): number

• Reads characters until the given string has been found or the string length has been reached.

  Parameters

  • string: string

    The string to match

  Returns number

  number Returns the start index.

while

• while(predicate): number

• Reads characters until the predicate returns false or the data length has been reached.

  Parameters

  • predicate: ((charCode: number) => boolean)

    Given the char code at the cursor index, returns true if the character should be included in the substring result.

    • • (charCode): boolean

      • Parameters

        • charCode: number

        Returns boolean

  Returns number

  number The start position.

white

• white(): number

• Reads through all whitespace characters, returning the starting index.

  Returns number