Installation

npm install --save @types/tar-stream

Summary

This package contains type definitions for tar-stream (https://github.com/mafintosh/tar-stream).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar-stream.

index.d.ts

1/// <reference types="node" />
2
3import stream = require("stream");
4
5export type Callback = (err?: Error | null) => any;
6
7// see https://github.com/mafintosh/tar-stream/blob/master/headers.js
8export interface Headers {
9    name: string;
10    mode?: number | undefined;
11    uid?: number | undefined;
12    gid?: number | undefined;
13    size?: number | undefined;
14    mtime?: Date | undefined;
15    linkname?: string | null | undefined;
16    type?:
17        | "file"
18        | "link"
19        | "symlink"
20        | "character-device"
21        | "block-device"
22        | "directory"
23        | "fifo"
24        | "contiguous-file"
25        | "pax-header"
26        | "pax-global-header"
27        | "gnu-long-link-path"
28        | "gnu-long-path"
29        | null
30        | undefined;
31    uname?: string | undefined;
32    gname?: string | undefined;
33    devmajor?: number | undefined;
34    devminor?: number | undefined;
35}
36
37export interface Pack extends stream.Readable {
38    /**
39     * To create a pack stream use tar.pack() and call pack.entry(header, [callback]) to add tar entries.
40     */
41    entry(headers: Headers, callback?: Callback): stream.Writable;
42    entry(headers: Headers, buffer?: string | Buffer, callback?: Callback): stream.Writable;
43    finalize(): void;
44    [Symbol.asyncIterator](): AsyncIterableIterator<Buffer>;
45}
46
47export interface Entry extends stream.Readable {
48    header: Headers;
49    [Symbol.asyncIterator](): AsyncIterableIterator<Buffer>;
50}
51
52export interface Extract extends stream.Writable {
53    on(event: string, listener: (...args: any[]) => void): this;
54    on(
55        event: "entry",
56        listener: (headers: Headers, stream: stream.PassThrough, next: (error?: unknown) => void) => void,
57    ): this;
58    [Symbol.asyncIterator](): AsyncIterator<Entry>;
59}
60
61export interface ExtractOptions extends stream.WritableOptions {
62    /**
63     * Whether or not to attempt to extract a file that does not have an
64     * officially supported format in the `magic` header, such as `ustar`.
65     */
66    allowUnknownFormat?: boolean | undefined;
67    /**
68     * The encoding of the file name header.
69     */
70    filenameEncoding?: BufferEncoding | undefined;
71}
72export function extract(opts?: ExtractOptions): Extract;
73
74export function pack(opts?: stream.ReadableOptions): Pack;
75

Additional Details

• Last updated: Tue, 07 Nov 2023 20:08:00 GMT
• Dependencies: @types/node

Credits

These definitions were written by Guy Lichtman, Piotr Błażejewicz, Kevin Lindsay, and Christian Rackerseder.