Class JsonObject<T>

Type Parameters

T = unknown

Hierarchy (View Summary)

JsonEntity<T>
- JsonObject

Index

Constructors

Properties

buffer consumed

Accessors

bufferLength entityType maxBufferSize

Methods

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

Constructors

constructor

new JsonObject<T = unknown>(buffer?: ByteStream | ByteBuffer): JsonObject<T>
Type Parameters
- T = unknown
Parameters
- Optionalbuffer: ByteStream | ByteBuffer
Returns JsonObject<T>
Inherited from JsonEntity.constructor
- Defined in parser.ts:70

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<[JsonString, JsonValue], any, any>
Returns AsyncGenerator<[JsonString, JsonValue], any, any>
- Defined in parser.ts:388

[iterator]

"[iterator]"(): Generator<[JsonString, JsonValue], any, any>
Returns Generator<[JsonString, JsonValue], any, any>
- Defined in parser.ts:384

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

members

members(): Generator<[JsonString, JsonValue]>
Returns Generator<[JsonString, JsonValue]>
- Defined in parser.ts:316

membersAsync

membersAsync(): AsyncGenerator<[JsonString, JsonValue]>
Returns AsyncGenerator<[JsonString, JsonValue]>
- Defined in parser.ts:358

`Protected`parse

parse(): T
Returns T
Overrides JsonEntity.parse
- Defined in parser.ts:392

read

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

readAsync

readAsync(): Promise<T>
Returns Promise<T>
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 = JsonObject<T>>(cb: (entity: this) => T): T | undefined
Type Parameters
- T = JsonObject<T>
Parameters
- cb: (entity: this) => T
Returns T | undefined
Inherited from JsonEntity.tryParse
- Defined in parser.ts:142