Class: DecoderPool
Defined in: pool/pool.ts:43
Manages a pool of Web Workers for off-main-thread tile decoding.
Use defaultDecoderPool to create a pool backed by the built-in, default decompressors.
When no createWorker factory is provided, decoding falls back to the main
thread. This lets the pool be constructed unconditionally and wired up with
a worker later (or never, for SSR / Node environments).
Constructors
Constructor
new DecoderPool(
options?):DecoderPool
Defined in: pool/pool.ts:46
Parameters
options?
DecoderPoolOptions = {}
Returns
DecoderPool
Accessors
hasWorkers
Get Signature
get hasWorkers():
boolean
Defined in: pool/pool.ts:58
True when workers are available for off-main-thread decoding.
Returns
boolean
Methods
decode()
decode(
bytes,compression,metadata):Promise<DecodedPixels>
Defined in: pool/pool.ts:72
Decode a compressed tile buffer.
When workers are available, the compressed bytes buffer is transferred
zero-copy to the least-loaded worker. The returned DecodedPixels typed
array buffers are transferred back to the main thread.
When no workers are available, decoding runs on the main thread via the
normal decode() path.
Parameters
bytes
compression
Compression
metadata
Returns
destroy()
destroy():
void
Defined in: pool/pool.ts:92
Terminate all workers and release resources.
Returns
void