UNPKG

@types/tar-fs

Version:
68 lines (54 loc) 2.28 kB
# Installation > `npm install --save @types/tar-fs` # Summary This package contains type definitions for tar-fs (https://github.com/mafintosh/tar-fs). # Details Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar-fs. ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar-fs/index.d.ts) ````ts // Imported from: https://github.com/soywiz/typescript-node-definitions/d.ts /// <reference types="node" /> import { ReadStream } from "fs"; import * as tarStream from "tar-stream"; export function pack(cwd: string, opts?: PackOptions): tarStream.Pack; export function extract(cwd: string, opts?: ExtractOptions): tarStream.Extract; export type Pack = tarStream.Pack; export type Extract = tarStream.Extract; export interface Options { ignore?: ((name: string) => boolean) | undefined; filter?: ((name: string) => boolean) | undefined; map?: ((header: Headers) => Headers) | undefined; mapStream?: ((fileStream: ReadStream, header: Headers) => ReadStream) | undefined; dmode?: number | undefined; fmode?: number | undefined; readable?: boolean | undefined; writable?: boolean | undefined; strict?: boolean | undefined; } export interface PackOptions extends Options { entries?: string[] | undefined; dereference?: boolean | undefined; finalize?: boolean | undefined; finish?: ((pack: tarStream.Pack) => void) | undefined; pack?: tarStream.Pack | undefined; } export interface ExtractOptions extends Options { ignore?: ((name: string, header?: Headers) => boolean) | undefined; filter?: ((name: string, header?: Headers) => boolean) | undefined; strip?: number | undefined; } export interface Headers { name: string; mode: number; mtime: Date; size: number; type: "file" | "directory" | "link" | "symlink"; uid: number; gid: number; } ```` ### Additional Details * Last updated: Tue, 07 Nov 2023 15:11:36 GMT * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [@types/tar-stream](https://npmjs.com/package/@types/tar-stream) # Credits These definitions were written by [Umoxfo](https://github.com/Umoxfo), and [Chris Wiggins](https://github.com/chriswiggins).