Interface ZipOptions<TBuffer>

Configuration options for a ZipFS file system.

interface ZipOptions<TBuffer extends ArrayBufferLike = ArrayBuffer> {
    caseFold?: CaseFold;
    data: TBuffer | ArrayBufferView<TBuffer> | ZipDataSource<TBuffer>;
    disableAsyncCache?: boolean;
    lazy?: boolean;
    name?: string;
}

Type Parameters

TBuffer extends ArrayBufferLike = ArrayBuffer

Hierarchy

SharedConfig
- ZipOptions

Index

Properties

caseFold? data disableAsyncCache? lazy? name?

Properties

`Optional`caseFold

caseFold?: CaseFold

If set, sets case folding for the file system(s).

data

data: TBuffer | ArrayBufferView<TBuffer> | ZipDataSource<TBuffer>

The zip file as a binary buffer.

`Optional`disableAsyncCache

disableAsyncCache?: boolean

If set, disables the sync cache and sync operations on async file systems.

`Optional`lazy

lazy?: boolean

Whether to wait to initialize entries

`Optional`name

name?: string

The name of the zip file (optional).