Class default

constructor

• new default(
      options?: {
          includes?: string;
          maxDepth?: number;
          startingPath?: JSONPathType;
      },
  ): default

• Convert a stream of bytes (in chunks) into a sequence of path/value pairs

  Parameters

  • Optionaloptions: { includes?: string; maxDepth?: number; startingPath?: JSONPathType } = {}

    • Optionalincludes?: string

      Expression using the includes syntax

    • OptionalmaxDepth?: number

      Max parsing depth

    • OptionalstartingPath?: JSONPathType

      The parser will consider this path as it is initial (useful to resume)

  Returns default

currentDepthInObject

currentPath

matcher

state

stringBuffer

tokenizer

isExhausted

• isExhausted(): boolean

• Check if there are no data to extract left considering the "includes" parameter

  Returns boolean

isFinished

• isFinished(): boolean

• Check if the JSON parsing completed correctly

  Returns boolean

iter

• iter(chunk: Uint8Array): Iterable<[JSONPathType, JSONValueType, number, number]>

• Parse a json or json fragment from a buffer, split in chunks (ArrayBuffers) and yields a sequence of path/value pairs It also yields the starting and ending byte of each value

  Parameters

  • chunk: Uint8Array

    an arraybuffer that is a chunk of a stream

  Returns Iterable<[JSONPathType, JSONValueType, number, number]>

  • path, value, byte start, and byte end when the value is in the buffer