DecompressionStream
E856196
DecompressionStream is a web API interface that provides a readable stream for decompressing data compressed with formats like gzip or deflate, typically used in conjunction with TransformStream for streaming transformations.
Statements (48)
| Predicate | Object |
|---|---|
| instanceOf |
ReadableStream wrapper
ⓘ
Web API interface ⓘ |
| availableInContext |
Window
ⓘ
Worker ⓘ |
| benefit |
enables progressive processing of compressed data
ⓘ
reduces memory usage for large payloads ⓘ |
| browserSupport |
Chromium-based browsers
ⓘ
partial or none in some other browsers ⓘ |
| canBePipedWith |
pipeThrough
ⓘ
pipeTo ⓘ |
| category | Client-side web APIs ⓘ |
| compressionDirection | decompression only ⓘ |
| dataTypeHandled |
Uint8Array chunks
ⓘ
binary data ⓘ |
| definedInSpecification | WHATWG Streams Standard NERFINISHED ⓘ |
| environmentRequirement | secure context ⓘ |
| errorCondition |
invalid compressed data
ⓘ
unsupported format string ⓘ |
| exampleUsage | response.body.pipeThrough(new DecompressionStream('gzip')) ⓘ |
| executionEnvironment |
web browsers
ⓘ
web workers ⓘ |
| exposesProperty | readable ⓘ |
| formatParameterAllowedValue |
"deflate"
ⓘ
"deflate-raw" ⓘ "gzip" ⓘ |
| formatParameterType | DOMString ⓘ |
| hasConstructorSignature | new DecompressionStream(format) GENERATED ⓘ |
| introducedFor | streaming decompression of data ⓘ |
| language | JavaScript NERFINISHED ⓘ |
| notSupportedFor | arbitrary custom compression formats ⓘ |
| parameter | format ⓘ |
| primaryUseCase |
decompress HTTP response bodies
ⓘ
decompress binary data in streams ⓘ |
| readablePropertyType | ReadableStream ⓘ |
| relatedConcept |
Streams API
NERFINISHED
ⓘ
TransformStream NERFINISHED ⓘ |
| relatedInterface | CompressionStream NERFINISHED ⓘ |
| returnsOnError | errored readable stream ⓘ |
| status | experimental in some browsers ⓘ |
| streamOrientation | byte streams ⓘ |
| supportsBackpressure | true ⓘ |
| supportsCompressionFormat |
deflate
GENERATED
ⓘ
deflate-raw GENERATED ⓘ gzip GENERATED ⓘ |
| supportsStreaming | true ⓘ |
| usedWith |
ReadableStream
NERFINISHED
ⓘ
TransformStream NERFINISHED ⓘ WritableStream NERFINISHED ⓘ |
Referenced by (1)
Full triples — surface form annotated when it differs from this entity's canonical label.