1 | # Installation
|
2 | > `npm install --save @types/tar-fs`
|
3 |
|
4 | # Summary
|
5 | This package contains type definitions for tar-fs (https://github.com/mafintosh/tar-fs).
|
6 |
|
7 | # Details
|
8 | Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar-fs.
|
9 | ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar-fs/index.d.ts)
|
10 | ````ts
|
11 | // Imported from: https://github.com/soywiz/typescript-node-definitions/d.ts
|
12 |
|
13 | /// <reference types="node" />
|
14 |
|
15 | import { ReadStream } from "fs";
|
16 | import * as tarStream from "tar-stream";
|
17 |
|
18 | export function pack(cwd: string, opts?: PackOptions): tarStream.Pack;
|
19 | export function extract(cwd: string, opts?: ExtractOptions): tarStream.Extract;
|
20 |
|
21 | export type Pack = tarStream.Pack;
|
22 | export type Extract = tarStream.Extract;
|
23 |
|
24 | export interface Options {
|
25 | ignore?: ((name: string) => boolean) | undefined;
|
26 | filter?: ((name: string) => boolean) | undefined;
|
27 | map?: ((header: Headers) => Headers) | undefined;
|
28 | mapStream?: ((fileStream: ReadStream, header: Headers) => ReadStream) | undefined;
|
29 | dmode?: number | undefined;
|
30 | fmode?: number | undefined;
|
31 | readable?: boolean | undefined;
|
32 | writable?: boolean | undefined;
|
33 | strict?: boolean | undefined;
|
34 | }
|
35 |
|
36 | export interface PackOptions extends Options {
|
37 | entries?: string[] | undefined;
|
38 | dereference?: boolean | undefined;
|
39 | finalize?: boolean | undefined;
|
40 | finish?: ((pack: tarStream.Pack) => void) | undefined;
|
41 | pack?: tarStream.Pack | undefined;
|
42 | }
|
43 |
|
44 | export interface ExtractOptions extends Options {
|
45 | ignore?: ((name: string, header?: Headers) => boolean) | undefined;
|
46 | filter?: ((name: string, header?: Headers) => boolean) | undefined;
|
47 | strip?: number | undefined;
|
48 | }
|
49 |
|
50 | export interface Headers {
|
51 | name: string;
|
52 | mode: number;
|
53 | mtime: Date;
|
54 | size: number;
|
55 | type: "file" | "directory" | "link" | "symlink";
|
56 | uid: number;
|
57 | gid: number;
|
58 | }
|
59 |
|
60 | ````
|
61 |
|
62 | ### Additional Details
|
63 | * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
|
64 | * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [@types/tar-stream](https://npmjs.com/package/@types/tar-stream)
|
65 |
|
66 | # Credits
|
67 | These definitions were written by [Umoxfo](https://github.com/Umoxfo), and [Chris Wiggins](https://github.com/chriswiggins).
|
68 |
|
\ | No newline at end of file |