CompressedData

CompressedData<T, TFormat> = NominalType<"compressionFormat", TFormat> & T

Use this to produce a new type that satisfies the original type, but adds extra type information that marks the type as containing compressed data.

Type Parameters

Type Parameter	Description
`T`	The base type to mark as representing compressed data
`TFormat` extends `CompressionFormat`	The compression format of the underlying data

Example

const untaggedData = new Uint8Array([/* ... */]);
const compressedData = untaggedData as CompressedData<typeof untaggedData, 'zstd'>;
 
compressedData satisfies CompressedData<Uint8Array, 'zstd'>; // OK
untaggedData satisfies CompressedData<Uint8Array, 'zstd'>; // ERROR

CompressedData

Type Parameters

Example

On this page