Class JsonBoolean<T>

consumed

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

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

eof

• set eof(value: boolean): void

  Sets the end-of-file (EOF) state of the buffer, indicating whether no more data will be added.

  Parameters

  • value: boolean

  Returns void

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

postComments

• get postComments(): Generator<JsonComment>

  Generators for post-comments. In JSONC, comments can appear before or after any value.

  Returns Generator<JsonComment>

postCommentsAsync

• get postCommentsAsync(): AsyncGenerator<JsonComment>

  Async generators for post-comments. In JSONC, comments can appear before or after any value.

  Returns AsyncGenerator<JsonComment>

postCommentStrings

• get postCommentStrings(): string[]

  Convenience getters to read all post comments as strings. Consumes the comments in the process.

  Returns string[]

preComments

• get preComments(): Generator<JsonComment>

  Generators for pre-comments. In JSONC, comments can appear before or after any value.

  Returns Generator<JsonComment>

preCommentsAsync

• get preCommentsAsync(): AsyncGenerator<JsonComment>

  Async generators for pre-comments. In JSONC, comments can appear before or after any value.

  Returns AsyncGenerator<JsonComment>

preCommentStrings

• get preCommentStrings(): string[]

  Convenience getters to read all pre comments as strings. Consumes the comments in the process.

  Returns string[]

singlePostCommentString

• get singlePostCommentString(): string | null

  Convenience getter to read a single post comment as a string. Returns null if no comments are present. Consumes the comment in the process.

  Returns string | null

singlePreCommentString

• get singlePreCommentString(): string | null

  Convenience getter to read a single pre comment as a string. Returns null if no comments are present. Consumes the comment in the process.

  Returns string | null

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: 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

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 = JsonBoolean<T>>(cb: (entity: this) => T): T | undefined

  Attempts to parse by executing a callback, reverting buffer state on failure.

  Type Parameters

  • T = JsonBoolean<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

Staticstringify

• 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

StaticstringifyAsync

• 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

StaticstringifyBytes

• 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

StaticstringifyBytesAsync

• 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