Interface SigDbCodecSpec

a compression codec: its file extension plus sync + streaming (de)compression

interface SigDbCodecSpec {
    codec: SigDbCodec;
    compressSync(
        buf: string | Buffer<ArrayBufferLike>,
        opts?: CodecCompressOptions,
    ): Buffer;
    createCompress(opts?: CodecCompressOptions): Transform;
    ext: string;
}

Index

Properties

Methods

compressSync createCompress

Properties

`Readonly`codec

codec: SigDbCodec

`Readonly`ext

ext: string

Methods

compressSync

compressSync(
buf: string | Buffer<ArrayBufferLike>,
opts?: CodecCompressOptions,
): Buffer
Parameters
- buf: string | Buffer<ArrayBufferLike>
- Optionalopts: CodecCompressOptions
Returns Buffer
- Defined in src/project/sigdb/codec.ts:78

createCompress

createCompress(opts?: CodecCompressOptions): Transform
Parameters
- Optionalopts: CodecCompressOptions
Returns Transform
- Defined in src/project/sigdb/codec.ts:79