Class JsonString<T>

Represents a JSON string value. Parses and stores string data from the buffer.

Type Parameters

T extends string = string
The specific string type (defaults to string)

Hierarchy (View Summary)

JsonEntity<T>
- JsonString

Index

Constructors

constructor

new JsonString<T extends string = string>(
buffer?: ByteStream | ByteBuffer,
): JsonString<T>
Creates a new JSON entity.
Type Parameters
- T extends string = string
  The specific string type (defaults to string)
Parameters
- Optionalbuffer: ByteStream | ByteBuffer
  Optional ByteBuffer or ByteStream to read from
Returns JsonString<T>
Inherited from JsonEntity.constructor
- Defined in packages/json-stream-lite/src/parser.ts:120

Properties

`Protected`buffer

buffer: ByteBuffer

consumed

consumed: boolean = false

Accessors

allowBufferToBeExceeded

set allowBufferToBeExceeded(value: boolean): void
Sets whether to allow exceeding the buffer size temporarily. Default is true.
Parameters
- value: boolean
  True to allow exceeding the buffer size, false to enforce the limit
Returns void
Inherited from JsonEntity.allowBufferToBeExceeded
- Defined in packages/json-stream-lite/src/parser.ts:139

bufferLength

get bufferLength(): number
Gets the current length of the buffer.

Returns number
The number of bytes in the buffer
Inherited from JsonEntity.bufferLength
- Defined in packages/json-stream-lite/src/parser.ts:159

entityType

get entityType(): string
Gets the type name of this entity.

Returns string
The constructor name of this entity
Inherited from JsonEntity.entityType
- Defined in packages/json-stream-lite/src/parser.ts:130

maxBufferSize

set maxBufferSize(size: number): void
Sets the maximum buffer size before compaction occurs. Defaults to 100 KB. NOTE: The buffer size may be exceeded temporarily during reads. For example, if a large string is read that exceeds the max size. If this is not desired, set allowBufferToBeExceeded to false (default is true).
Parameters
- size: number
  The maximum buffer size in bytes
Returns void
Inherited from JsonEntity.maxBufferSize
- Defined in packages/json-stream-lite/src/parser.ts:150

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncGenerator<string, any, any>
Returns an async iterator for string chunks. Enables use of for await...of loops on JsonString.

Returns AsyncGenerator<string, any, any>
Yields
Chunks of the string content
- Defined in packages/json-stream-lite/src/parser.ts:520

[iterator]

"[iterator]"(): Generator<string, any, any>
Returns an iterator for string chunks. Enables use of for...of loops on JsonString.

Returns Generator<string, any, any>
Yields
Chunks of the string content
- Defined in packages/json-stream-lite/src/parser.ts:511

consume

consume(): void
Consumes the entity by reading it if not already consumed.

Returns void
Inherited from JsonEntity.consume
- Defined in packages/json-stream-lite/src/parser.ts:234

consumeAsync

consumeAsync(): Promise<void>
Asynchronously consumes the entity by reading it if not already consumed.

Returns Promise<void>
Inherited from JsonEntity.consumeAsync
- Defined in packages/json-stream-lite/src/parser.ts:243

feed

feed(...input: StreamInput[]): void
Feeds input data into the buffer.
Parameters
- ...input: StreamInput[]
  One or more strings, numbers, arrays of numbers, or Uint8Arrays to add to the buffer
Returns void
Inherited from JsonEntity.feed
- Defined in packages/json-stream-lite/src/parser.ts:168

`Protected`parse

parse(): T
Parses a JSON string from the buffer.

Returns T
The parsed string value
Overrides JsonEntity.parse
- Defined in packages/json-stream-lite/src/parser.ts:344

read

read(): T
Reads and parses the entity, consuming it in the process.

Returns T
The parsed value

Throws
Error if the entity has already been consumed
Inherited from JsonEntity.read
- Defined in packages/json-stream-lite/src/parser.ts:196

readAsync

readAsync(): Promise<T>
Asynchronously reads and parses the entity from a stream.

Returns Promise<T>
A promise that resolves to the parsed value

Throws
Error if the entity has already been consumed
Inherited from JsonEntity.readAsync
- Defined in packages/json-stream-lite/src/parser.ts:215

`Protected`skipWhitespace

skipWhitespace(): void
Skips whitespace characters in the buffer.

Returns void
Inherited from JsonEntity.skipWhitespace
- Defined in packages/json-stream-lite/src/parser.ts:184

stream

stream(chunkSize?: number): Generator<string>
Generator that yields the string content as chunks of strings.
Parameters
- chunkSize: number = 1024
  The maximum size of each yielded string chunk (defaults to 1024)
Returns Generator<string>
Yields
Chunks of the string content
- Defined in packages/json-stream-lite/src/parser.ts:489

streamAsync

streamAsync(chunkSize?: number): AsyncGenerator<string>
Async generator that yields the string content as chunks of strings.
Parameters
- chunkSize: number = 1024
  The maximum size of each yielded string chunk (defaults to 1024)
Returns AsyncGenerator<string>
Yields
Chunks of the string content
- Defined in packages/json-stream-lite/src/parser.ts:500

streamBytes

streamBytes(chunkSize?: number): Generator<Uint8Array<ArrayBufferLike>>
Generator that yields the string content as raw byte chunks. Handles escape sequences by converting them to their actual byte values.
Parameters
- chunkSize: number = 1024
  The maximum size of each yielded byte array chunk (defaults to 1024)
Returns Generator<Uint8Array<ArrayBufferLike>>
Yields
Uint8Array chunks containing the unescaped string bytes
- Defined in packages/json-stream-lite/src/parser.ts:357

streamBytesAsync

streamBytesAsync(
chunkSize?: number,
): AsyncGenerator<Uint8Array<ArrayBufferLike>>
Async generator that yields the string content as raw byte chunks from a stream. Handles escape sequences by converting them to their actual byte values. Waits for more data from the stream when needed.
Parameters
- chunkSize: number = 1024
  The maximum size of each yielded byte array chunk (defaults to 1024)
Returns AsyncGenerator<Uint8Array<ArrayBufferLike>>
Yields
Uint8Array chunks containing the unescaped string bytes
- Defined in packages/json-stream-lite/src/parser.ts:460

tryParse

tryParse<T = JsonString<T>>(cb: (entity: this) => T): T | undefined
Attempts to parse by executing a callback, reverting buffer state on failure.
Type Parameters
- T = JsonString<T>
  The return type of the callback
Parameters
- cb: (entity: this) => T
  The callback function to execute
Returns T | undefined
The result of the callback, or undefined if parsing needs more data

Throws
Error if the entity has already been consumed
Inherited from JsonEntity.tryParse
- Defined in packages/json-stream-lite/src/parser.ts:257

`Static`stringify

stringify(
    value: unknown,
    replacer?: any,
    indent?: number,
    options?: JsonStreamStringifyOptions,
): Generator<string>
Serializes a value into a JSON string using json-stream-lite. See jsonStreamStringify for more details.
Parameters
- value: unknown
- Optionalreplacer: any
- indent: number = 0
- Optionaloptions: JsonStreamStringifyOptions
Returns Generator<string>
A generator yielding JSON string chunks
Inherited from JsonEntity.stringify
- Defined in packages/json-stream-lite/src/parser.ts:280

`Static`stringifyAsync

stringifyAsync(
    value: AsyncIterable<unknown, any, any> | Iterable<unknown, any, any>,
    replacer?: any,
    indent?: number,
    options?: JsonStreamStringifyOptions,
): AsyncGenerator<string>
Asynchronously serializes a value into a JSON string using json-stream-lite. See jsonStreamStringifyAsync for more details.
Parameters
- value: AsyncIterable<unknown, any, any> | Iterable<unknown, any, any>
- Optionalreplacer: any
- indent: number = 0
- Optionaloptions: JsonStreamStringifyOptions
Returns AsyncGenerator<string>
An async generator yielding JSON string chunks
Inherited from JsonEntity.stringifyAsync
- Defined in packages/json-stream-lite/src/parser.ts:308

`Static`stringifyBytes

stringifyBytes(
    value: unknown,
    replacer?: any,
    indent?: number,
    options?: JsonStreamStringifyOptions,
): Generator<Uint8Array<ArrayBufferLike>>
Serializes a value into JSON as Uint8Array byte chunks using json-stream-lite. See jsonStreamStringifyBytes for more details.
Parameters
- value: unknown
- Optionalreplacer: any
- indent: number = 0
- Optionaloptions: JsonStreamStringifyOptions
Returns Generator<Uint8Array<ArrayBufferLike>>
A generator yielding JSON byte chunks
Inherited from JsonEntity.stringifyBytes
- Defined in packages/json-stream-lite/src/parser.ts:294

`Static`stringifyBytesAsync

stringifyBytesAsync(
    value: AsyncIterable<unknown, any, any> | Iterable<unknown, any, any>,
    replacer?: any,
    indent?: number,
    options?: JsonStreamStringifyOptions,
): AsyncGenerator<Uint8Array<ArrayBufferLike>>
Asynchronously serializes a value into JSON as Uint8Array byte chunks using json-stream-lite. See jsonStreamStringifyBytesAsync for more details.
Parameters
- value: AsyncIterable<unknown, any, any> | Iterable<unknown, any, any>
- Optionalreplacer: any
- indent: number = 0
- Optionaloptions: JsonStreamStringifyOptions
Returns AsyncGenerator<Uint8Array<ArrayBufferLike>>
An async generator yielding JSON byte chunks
Inherited from JsonEntity.stringifyBytesAsync
- Defined in packages/json-stream-lite/src/parser.ts:322

Class JsonString<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns JsonString<T>

Properties

Protectedbuffer

consumed

Accessors

allowBufferToBeExceeded

Parameters

Returns void

bufferLength

Returns number

entityType

Returns string

maxBufferSize

Parameters

Returns void

Methods

[asyncIterator]

Returns AsyncGenerator<string, any, any>

Yields

[iterator]

Returns Generator<string, any, any>

Yields

consume

Returns void

consumeAsync

Returns Promise<void>

feed

Parameters

Returns void

Protectedparse

Returns T

read

Returns T

Throws

readAsync

Returns Promise<T>

Throws

ProtectedskipWhitespace

Returns void

stream

Parameters

Returns Generator<string>

Yields

streamAsync

Parameters

Returns AsyncGenerator<string>

Yields

streamBytes

Parameters

Returns Generator<Uint8Array<ArrayBufferLike>>

Yields

streamBytesAsync

Parameters

Returns AsyncGenerator<Uint8Array<ArrayBufferLike>>

Yields

tryParse

Type Parameters

Parameters

Returns T | undefined

Throws

Staticstringify

Parameters

Returns Generator<string>

StaticstringifyAsync

Parameters

Returns AsyncGenerator<string>

StaticstringifyBytes

Parameters

`Protected`buffer

`Protected`parse

`Protected`skipWhitespace

`Static`stringify

`Static`stringifyAsync

`Static`stringifyBytes

`Static`stringifyBytesAsync