Interface TarStreamFileExperimental

The interface required to provide a file.

UNSTABLE: New API, yet to be vetted.

interface TarStreamFile {
    options?: TarStreamOptions;
    path: string;
    readable: ReadableStream<Uint8Array>;
    size: number;
    type: "file";
}

Properties

The metadata of the file.

path: string

The path to the file, relative to the archive's root directory.

readable: ReadableStream<Uint8Array>

The contents of the file.

size: number

The size of the file in bytes.

type

The type of the input.