Class ReadableStreamParser

Creates a ReadableStream from Binary file, that actually waits until the reading operator has caught up before it pushes more.

Index

Constructors

Methods

CreateReadableStreamFromSaveToJson

Constructors

constructor

new ReadableStreamParser(): ReadableStreamParser
Returns ReadableStreamParser

Methods

`Static`CreateReadableStreamFromSaveToJson

CreateReadableStreamFromSaveToJson(
    name: string,
    bytes: ArrayBufferLike,
    options?: Partial<
        {
            onDecompressedSaveBody: (buffer: ArrayBufferLike) => void;
            onProgress: (progress: number, message?: string) => void;
        },
    >,
): { startStreaming: () => Promise<void>; stream: any }
the more elegant way to parse saves, instead of using the plain ParseSave. Since streaming will not hold the converted JSON in memory at once.
Parameters
- name: string
  the save name
- bytes: ArrayBufferLike
  the save file as UInt8Array
- Optionaloptions: Partial<
      {
          onDecompressedSaveBody: (buffer: ArrayBufferLike) => void;
          onProgress: (progress: number, message?: string) => void;
      },
  >
Returns { startStreaming: () => Promise<void>; stream: any }
a WHATWG compliant readable stream of strings (They are valid JSON and represent a SatisfactorySave object). And a method to actually start the streaming for more precise control.
- Defined in src/parser/stream/reworked/readable-stream-parser.ts:127