ZstdCompressContext
Defined in: index.d.ts:59
Streaming zstd compression context.
Maintains internal compression state across multiple transform calls,
enabling chunked compression without losing cross-chunk context.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ZstdCompressContext(
level?):ZstdCompressContext
Defined in: index.d.ts:876
Parameters
Section titled “Parameters”level?
Section titled “level?”number | null
Returns
Section titled “Returns”ZstdCompressContext
Methods
Section titled “Methods”[dispose]()
Section titled “[dispose]()”[dispose]():
void
Defined in: index.d.ts:61
Close the context, like close(): using declarations call it.
Returns
Section titled “Returns”void
close()
Section titled “close()”close():
void
Defined in: index.d.ts:896
Release the native state of the context now rather than when the
context is garbage-collected. Later calls throw, and finish()
releases the state too. Closing a finished or closed context does
nothing. [Symbol.dispose]() is the same method, for using
declarations.
Returns
Section titled “Returns”void
finish()
Section titled “finish()”finish():
Buffer
Defined in: index.d.ts:888
Finalize the compression stream. Writes the zstd frame footer. Must be called once after all data has been transformed.
Returns
Section titled “Returns”Buffer
finishAsync()
Section titled “finishAsync()”finishAsync():
Promise<Buffer<ArrayBufferLike>>
Defined in: index.d.ts:939
finish() on the libuv thread pool: returns a Promise of the rest
of the output, and reports every error by rejecting it. The native
state is released once the call has run, whether it succeeded or
not. In the browser build, it runs synchronously, on the calling
thread.
At most one asynchronous call may be in flight per context: until
its Promise settles, another asynchronous call rejects and a
synchronous call throws <name> is busy: an asynchronous call has not finished. After close(), calls reject with <name> already closed.
Returns
Section titled “Returns”Promise<Buffer<ArrayBufferLike>>
flush()
Section titled “flush()”flush():
Buffer
Defined in: index.d.ts:883
Flush the encoder’s internal buffer. Returns any buffered compressed data.
Returns
Section titled “Returns”Buffer
flushAsync()
Section titled “flushAsync()”flushAsync():
Promise<Buffer<ArrayBufferLike>>
Defined in: index.d.ts:925
flush() on the libuv thread pool: returns a Promise of the
output, and reports every error by rejecting it. In the browser
build, it runs synchronously, on the calling thread.
At most one asynchronous call may be in flight per context: until
its Promise settles, another asynchronous call rejects and a
synchronous call throws <name> is busy: an asynchronous call has not finished. After close(), calls reject with <name> already closed.
Returns
Section titled “Returns”Promise<Buffer<ArrayBufferLike>>
transform()
Section titled “transform()”transform(
chunk):Buffer
Defined in: index.d.ts:881
Compress a chunk of data. Returns compressed output (may be empty if the encoder is buffering data internally).
Parameters
Section titled “Parameters”Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>
Returns
Section titled “Returns”Buffer
transformAsync()
Section titled “transformAsync()”transformAsync(
chunk):Promise<Buffer<ArrayBufferLike>>
Defined in: index.d.ts:913
transform(chunk) on the libuv thread pool: returns a Promise of
the output, and reports every error, an invalid argument included,
by rejecting it. The chunk is copied before the method returns, so
the caller may reuse its memory at once. In the browser build, it
runs synchronously, on the calling thread.
At most one asynchronous call may be in flight per context: until
its Promise settles, another asynchronous call rejects and a
synchronous call throws <name> is busy: an asynchronous call has not finished, such as zstd stream is busy: an asynchronous call has not finished. close() while a call is in flight releases
the native state once the call settles, and its Promise still
settles. After close(), calls reject with <name> already closed.
Parameters
Section titled “Parameters”Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>
Returns
Section titled “Returns”Promise<Buffer<ArrayBufferLike>>