Class Scanner

constructor

• new Scanner(input: string): Scanner

• Constructors a new lexer.

  Parameters

  • input: string

    The input haystack filter string to process.

  Returns Scanner

current

index

Readonlyinput

next

consume

• consume(): this

• Consume the next character.

  Returns this

  The scanner instance.

consumeSpacesAndTabs

• consumeSpacesAndTabs(): this

• Consume any space and tab characters.

  This does not consume all different types of white space - just space and tab characters.

  Returns this

  The scanner instance.

consumeWhiteSpace

• consumeWhiteSpace(): this

• Consume any white space characters.

  Returns this

  The scanner instance.

expect

• expect(expected: string, id: string): this

• Expect the current character or throw an error.

  Parameters

  • expected: string

    The expected character.
  • id: string

    The expected id.

  Returns this

  The scanner instance.

  Throws

  An error if the two values don't match.

expectAndConsumeNewLine

• expectAndConsumeNewLine(id: string): this

• Expect a new line character and consume it.

  This will handle carriage return line feeds as well.

  Parameters

  • id: string

    The expected id.

  Returns this

  The scanner instance.

  Throws

  An error if a newline isn't found.

is

• is(c: null | string): boolean

• Return true if the specified character matches the current character.

  Parameters

  • c: null | string

    The character to test.

  Returns boolean

  True if there's a match.

isDigit

• isDigit(): boolean

• Return true if the current character is a valid digit.

  Returns boolean

  True if valid number.

isEof

• isEof(): boolean

• Return true if the end of the data stream has been reached.

  Returns boolean

  True if EOF.

isHex

• isHex(): boolean

• Return true if the current character is a valid hex character

  Returns boolean

  True if this is a hex character.

isLetter

• isLetter(): boolean

• Return true if the current character is a valid letter (a-z and A-Z).

  Returns boolean

  True if valid letter.

isLowerCase

• isLowerCase(): boolean

• Return true if the current character is a string and is lower case.

  Returns boolean

  True if lower case.

isNewLine

• isNewLine(): boolean

• Return true if the current character is a newline.

  Returns boolean

  True if the current character is a new line.

isSpaceOrTab

• isSpaceOrTab(): boolean

• Returns boolean

  true if the current character is a space or tab.

isUpperCase

• isUpperCase(): boolean

• Return true if the current character is a string and is upper case.

  Returns boolean

  True if upper case.

isWhiteSpace

• isWhiteSpace(): boolean

• Return true if the current character is considered white space.

  Returns boolean

  True if white space.

StaticisDigit

• isDigit(c: null | string): boolean

• Return true if the character is a valid digit.

  Parameters

  • c: null | string

    The character to test.

  Returns boolean

  True if valid number.

StaticisHex

• isHex(c: null | string): boolean

• Return true if the character is a valid hex character

  Parameters

  • c: null | string

    The charcter to test.

  Returns boolean

  True if this is a hex character.

StaticisLetter

• isLetter(c: null | string): boolean

• Return true if the character is a valid letter (a-z and A-Z).

  Parameters

  • c: null | string

    The character to test.

  Returns boolean

  True if valid letter.

StaticisLowerCase

• isLowerCase(c: null | string): boolean

• Return true if the character is a string and is lower case.

  Parameters

  • c: null | string

    The character to test.

  Returns boolean

  True if lower case.

StaticisNewLine

• isNewLine(c: null | string): boolean

• Return true if the character is a newline.

  Parameters

  • c: null | string

    The character to test.

  Returns boolean

  True if the character is a new line.

StaticisSpaceOrTab

• isSpaceOrTab(c: null | string): boolean

• Return true if the character is a space or a tab.

  Parameters

  • c: null | string

    The character to test.

  Returns boolean

  True if a space or a tab.

StaticisUpperCase

• isUpperCase(c: null | string): boolean

• Return true if the character is a string and is upper case.

  Parameters

  • c: null | string

    The character to test.

  Returns boolean

  True if upper case.

StaticisWhiteSpace

• isWhiteSpace(c: null | string): boolean

• Return true if the character is considered white space.

  Parameters

  • c: null | string

    The character to test.

  Returns boolean

  True if white space.