Class JsonKeyValueParser

Hierarchy (View Summary)

JsonEntity<Generator<JsonKeyValuePair>>
- JsonKeyValueParser

Index

Constructors

Properties

buffer consumed

Accessors

bufferLength entityType maxBufferSize

Methods

[asyncIterator] [iterator] consume consumeAsync feed parse parseAsync read readAsync skipWhitespace tryParse

Constructors

constructor

new JsonKeyValueParser(
    buffer?: ByteStream | ByteBuffer,
    container?: JsonValue | JsonObject<unknown> | JsonArray<unknown>,
    parentKey?: string,
): JsonKeyValueParser
Parameters
- Optionalbuffer: ByteStream | ByteBuffer
- Optionalcontainer: JsonValue | JsonObject<unknown> | JsonArray<unknown>
- OptionalparentKey: string
Returns JsonKeyValueParser
Overrides JsonEntity.constructor
- Defined in parser.ts:482

Properties

`Protected`buffer

buffer: ByteBuffer

consumed

consumed: boolean = false

Accessors

bufferLength

get bufferLength(): number
Returns number
Inherited from JsonEntity.bufferLength
- Defined in parser.ts:83

entityType

get entityType(): string
Returns string
Inherited from JsonEntity.entityType
- Defined in parser.ts:75

maxBufferSize

set maxBufferSize(size: number): void
Parameters
- size: number
Returns void
Inherited from JsonEntity.maxBufferSize
- Defined in parser.ts:79

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncGenerator<JsonKeyValuePair, any, any>
Returns AsyncGenerator<JsonKeyValuePair, any, any>
- Defined in parser.ts:577

[iterator]

"[iterator]"(): Generator<JsonKeyValuePair, any, any>
Returns Generator<JsonKeyValuePair, any, any>
- Defined in parser.ts:573

consume

consume(): void
Returns void
Inherited from JsonEntity.consume
- Defined in parser.ts:130

consumeAsync

consumeAsync(): Promise<void>
Returns Promise<void>
Inherited from JsonEntity.consumeAsync
- Defined in parser.ts:136

feed

feed(...input: (number | number[])[]): void
Parameters
- ...input: (number | number[])[]
Returns void
Inherited from JsonEntity.feed
- Defined in parser.ts:87

parse

parse(): Generator<JsonKeyValuePair>
Returns Generator<JsonKeyValuePair>
Overrides JsonEntity.parse
- Defined in parser.ts:492

parseAsync

parseAsync(): AsyncGenerator<JsonKeyValuePair>
Returns AsyncGenerator<JsonKeyValuePair>
- Defined in parser.ts:552

read

read(): Generator
Returns Generator
Inherited from JsonEntity.read
- Defined in parser.ts:101

readAsync

readAsync(): Promise<Generator<JsonKeyValuePair, any, any>>
Returns Promise<Generator<JsonKeyValuePair, any, any>>
Inherited from JsonEntity.readAsync
- Defined in parser.ts:114

`Protected`skipWhitespace

skipWhitespace(): void
Returns void
Inherited from JsonEntity.skipWhitespace
- Defined in parser.ts:95

tryParse

tryParse<T = JsonKeyValueParser>(cb: (entity: this) => T): T | undefined
Type Parameters
- T = JsonKeyValueParser
Parameters
- cb: (entity: this) => T
Returns T | undefined
Inherited from JsonEntity.tryParse
- Defined in parser.ts:142