Class JsonString<T>

consumed

bufferLength

• get bufferLength(): number

  Gets the current length of the buffer.

  Returns number

  The number of bytes in the buffer

entityType

• get entityType(): string

  Gets the type name of this entity.

  Returns string

  The constructor name of this entity

maxBufferSize

• set maxBufferSize(size: number): void

  Sets the maximum buffer size before compaction occurs.

  Parameters

  • size: number

    The maximum buffer size in bytes

  Returns void

consume

• consume(): void

  Consumes the entity by reading it if not already consumed.

  Returns void

consumeAsync

• consumeAsync(): Promise<void>

  Asynchronously consumes the entity by reading it if not already consumed.

  Returns Promise<void>

feed

• feed(...input: JsonStreamInput[]): void

  Feeds input data into the buffer.

  Parameters

  • ...input: JsonStreamInput[]

    One or more strings, numbers, arrays of numbers, or Uint8Arrays to add to the buffer

  Returns void

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

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

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