Class StringReader

Implements

default

Constructors

constructor

new StringReader(other: string | StringReader): StringReader
Parameters
- other: string | StringReader
Returns StringReader
- Defined in packages/brigadier/src/StringReader.ts:12

Methods

canRead

canRead(length?: number): boolean
Parameters
- length: number = 1
Returns boolean
Implementation of ImmutableStringReader.canRead
- Defined in packages/brigadier/src/StringReader.ts:49

expect

expect(c: string): void
Parameters
- c: string
Returns void
- Defined in packages/brigadier/src/StringReader.ts:189

getCursor

getCursor(): number
Returns number
Implementation of ImmutableStringReader.getCursor
- Defined in packages/brigadier/src/StringReader.ts:37

getRead

getRead(): string
Returns string
Implementation of ImmutableStringReader.getRead
- Defined in packages/brigadier/src/StringReader.ts:41

getRemaining

getRemaining(): string
Returns string
Implementation of ImmutableStringReader.getRemaining
- Defined in packages/brigadier/src/StringReader.ts:45

getRemainingLength

getRemainingLength(): number
Returns number
Implementation of ImmutableStringReader.getRemainingLength
- Defined in packages/brigadier/src/StringReader.ts:29

getString

getString(): string
Returns string
Implementation of ImmutableStringReader.getString
- Defined in packages/brigadier/src/StringReader.ts:21

getTotalLength

getTotalLength(): number
Returns number
Implementation of ImmutableStringReader.getTotalLength
- Defined in packages/brigadier/src/StringReader.ts:33

peek

peek(offset?: number): string
Parameters
- offset: number = 0
Returns string
Implementation of ImmutableStringReader.peek
- Defined in packages/brigadier/src/StringReader.ts:53

read

read(): string
Returns string
- Defined in packages/brigadier/src/StringReader.ts:57

readBoolean

readBoolean(): boolean
Returns boolean
- Defined in packages/brigadier/src/StringReader.ts:172

readFloat

readFloat(): number
Returns number
- Defined in packages/brigadier/src/StringReader.ts:93

readInt

readInt(): number
Returns number
- Defined in packages/brigadier/src/StringReader.ts:75

readQuotedString

readQuotedString(): string
Returns string
- Defined in packages/brigadier/src/StringReader.ts:132

readString

readString(): string
Returns string
- Defined in packages/brigadier/src/StringReader.ts:164

readUnquotedString

readUnquotedString(): string
Returns string
- Defined in packages/brigadier/src/StringReader.ts:123

setCursor

setCursor(cursor: number): void
Parameters
- cursor: number
Returns void
- Defined in packages/brigadier/src/StringReader.ts:25

skip

skip(): void
Returns void
- Defined in packages/brigadier/src/StringReader.ts:61

skipWhitespace

skipWhitespace(): void
Returns void
- Defined in packages/brigadier/src/StringReader.ts:69

`Static`isAllowedInUnquotedString

isAllowedInUnquotedString(c: string): boolean
Parameters
- c: string
Returns boolean
- Defined in packages/brigadier/src/StringReader.ts:111

`Static`isAllowedNumber

isAllowedNumber(c: string): boolean
Parameters
- c: string
Returns boolean
- Defined in packages/brigadier/src/StringReader.ts:65