@types/tar 4.0.3 → 6.1.1

tar/LICENSE

@@ -1,21 +1,21 @@
-    MIT License
-
-    Copyright (c) Microsoft Corporation. All rights reserved.
-
-    Permission is hereby granted, free of charge, to any person obtaining a copy
-    of this software and associated documentation files (the "Software"), to deal
-    in the Software without restriction, including without limitation the rights
-    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all
-    copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-    SOFTWARE
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

tar/README.md

@@ -5,12 +5,12 @@
 This package contains type definitions for tar (https://github.com/npm/node-tar).
 
 # Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar.
 
-Additional Details
- * Last updated: Wed, 10 Jul 2019 00:30:51 GMT
- * Dependencies: @types/minipass, @types/node
+### Additional Details
+ * Last updated: Sat, 20 Nov 2021 01:31:10 GMT
+ * Dependencies: [@types/minipass](https://npmjs.com/package/@types/minipass), [@types/node](https://npmjs.com/package/@types/node)
  * Global values: none
 
 # Credits
-These definitions were written by Maxime LUCE <https://github.com/SomaticIT>, and Connor Peet <https://github.com/connor4312>.
+These definitions were written by [Maxime LUCE](https://github.com/SomaticIT), and [Connor Peet](https://github.com/connor4312).

tar/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for tar 4.0
+// Type definitions for tar 6.1
 // Project: https://github.com/npm/node-tar
 // Definitions by: Maxime LUCE <https://github.com/SomaticIT>, Connor Peet <https://github.com/connor4312>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -15,24 +15,24 @@ import MiniPass = require('minipass');
 
 export interface HeaderProperties {
     path: string;
-    mode?: number;
-    noProprietary?: boolean;
-    uid?: number;
-    gid?: number;
-    size?: number;
-    mtime?: number;
-    type?: string;
-    uname?: string;
-    gname?: string;
-    devmaj?: number;
-    devmin?: number;
+    mode?: number | undefined;
+    noProprietary?: boolean | undefined;
+    uid?: number | undefined;
+    gid?: number | undefined;
+    size?: number | undefined;
+    mtime?: number | undefined;
+    type?: string | undefined;
+    uname?: string | undefined;
+    gname?: string | undefined;
+    devmaj?: number | undefined;
+    devmin?: number | undefined;
 }
 
 export interface ExtractOptions {
-    type?: string;
-    Directory?: boolean;
-    path?: string;
-    strip?: number;
+    type?: string | undefined;
+    Directory?: boolean | undefined;
+    path?: string | undefined;
+    strip?: number | undefined;
 }
 
 export interface ParseStream extends NodeJS.ReadWriteStream {
@@ -102,8 +102,8 @@ export const fieldEnds: number[];
  */
 export const types: {
     0: string;
-    "\0": string;
-    "": string;
+    '\0': string;
+    '': string;
     1: string;
     2: string;
     3: string;
@@ -198,14 +198,27 @@ export const knownExtended: {
 export const headerSize: number;
 export const blockSize: number;
 
+export interface ParseOptions {
+    strict?: boolean;
+    filter?: (path: string, entry: ReadEntry) => boolean;
+    onentry?: (entry: ReadEntry) => void;
+    onwarn?: (code: string, message: string, data: Buffer) => void;
+}
+/**
+ * A writable stream. Write tar data to it and it will emit entry events for each entry parsed from the tarball. This is used by tar.Extract.
+ */
+export interface Parse extends ParseStream {
+    on(event: 'end' | 'close', listener: () => void): this;
+    on(event: 'entry', listener: (entry: ReadEntry) => void): this;
+}
+
+export const Parse: {
+    new(opt?: ParseOptions): Parse;
+};
 //#endregion
 
 //#region Global Methods
 
-/**
- * Returns a writable stream. Write tar data to it and it will emit entry events for each entry parsed from the tarball. This is used by tar.Extract.
- */
-export function Parse(): ParseStream;
 /**
  * Returns a through stream. Use fstream to write files into the pack stream and you will receive tar archive data from the pack stream.
  * This only works with directories, it does not work with individual files.
@@ -264,28 +277,28 @@ export interface CreateOptions {
     /**
      * Treat warnings as crash-worthy errors. Default false.
      */
-    strict?: boolean;
+    strict?: boolean | undefined;
 
     /**
      * The current working directory for creating the archive. Defaults to process.cwd().
      */
-    cwd?: string;
+    cwd?: string | undefined;
 
     /**
      * Alias for cwd.
      */
-    C?: string;
+    C?: string | undefined;
 
     /**
      * Set to any truthy value to create a gzipped archive,
      * or an object with settings for zlib.Gzip()
      */
-    gzip?: boolean | zlib.ZlibOptions;
+    gzip?: boolean | zlib.ZlibOptions | undefined;
 
     /**
      * Alias for gzip.
      */
-    z?: boolean | zlib.ZlibOptions;
+    z?: boolean | zlib.ZlibOptions | undefined;
 
     /**
      * A function that gets called with (path, stat) for each entry being
@@ -298,55 +311,55 @@ export interface CreateOptions {
      * gname, dev, ino, and nlink. Note that mtime is still included,
      * because this is necessary other time-based operations.
      */
-    portable?: boolean;
+    portable?: boolean | undefined;
 
     /**
      * Allow absolute paths. By default, / is stripped from absolute paths.
      */
-    preservePaths?: boolean;
+    preservePaths?: boolean | undefined;
 
     /**
      * Alias for presevePaths.
      */
-    P?: boolean;
+    P?: boolean | undefined;
 
     /**
      * The mode to set on the created file archive.
      */
-    mode?: number;
+    mode?: number | undefined;
 
     /**
      * Do not recursively archive the contents of directories.
      */
-    noDirRecurse?: boolean;
+    noDirRecurse?: boolean | undefined;
 
     /**
      * Set to true to pack the targets of symbolic links. Without this
      * option, symbolic links are archived as such.
      */
-    follow?: boolean;
+    follow?: boolean | undefined;
 
     /**
      * Alias for follow.
      */
-    L?: boolean;
+    L?: boolean | undefined;
 
     /**
      * Alias for follow.
      */
-    h?: boolean;
+    h?: boolean | undefined;
 
     /**
      * Suppress pax extended headers. Note that this means that long paths and
      * linkpaths will be truncated, and large or negative numeric values
      * may be interpreted incorrectly.
      */
-    noPax?: boolean;
+    noPax?: boolean | undefined;
 
     /**
      * A path portion to prefix onto the entries in the archive.
      */
-    prefix?: string;
+    prefix?: string | undefined;
 }
 
 export interface ExtractOptions {
@@ -359,18 +372,18 @@ export interface ExtractOptions {
     /**
      * Treat warnings as crash-worthy errors. Default false.
      */
-    strict?: boolean;
+    strict?: boolean | undefined;
 
     /**
      * Extract files relative to the specified directory. Defaults to
      * process.cwd(). If provided, this must exist and must be a directory.
      */
-    cwd?: string;
+    cwd?: string | undefined;
 
     /**
      * Alias for cwd.
      */
-    C?: string;
+    C?: string | undefined;
 
     /**
      * A function that gets called with (path, stat) for each entry being
@@ -382,33 +395,33 @@ export interface ExtractOptions {
      * Set to true to keep the existing file on disk if it's newer than
      * the file in the archive.
      */
-    newer?: boolean;
+    newer?: boolean | undefined;
 
     /**
      * Alias for newer.
      */
-    'keep-newer'?: boolean;
+    'keep-newer'?: boolean | undefined;
 
     /**
      * Alias for newer.
      */
-    'keep-newer-files'?: boolean;
+    'keep-newer-files'?: boolean | undefined;
 
     /**
      * Do not overwrite existing files. In particular, if a file appears more
      * than once in an archive, later copies will not overwrite earlier copies
      */
-    keep?: boolean;
+    keep?: boolean | undefined;
 
     /**
      * Alias for keep.
      */
-    k?: boolean;
+    k?: boolean | undefined;
 
     /**
      * Alias for keep.
      */
-    'keep-existing'?: boolean;
+    'keep-existing'?: boolean | undefined;
 
     /**
      * Unlink files before creating them. Without this option, tar overwrites
@@ -416,24 +429,24 @@ export interface ExtractOptions {
      * existing hardlinks will be broken, as will any symlink that would
      * affect the location of an extracted file.
      */
-    unlink?: boolean;
+    unlink?: boolean | undefined;
 
     /**
      * Remove the specified number of leading path elements. Pathnames with
      * fewer elements will be silently skipped. Note that the pathname
      * is edited after applying the filter, but before security checks.
      */
-    strip?: number;
+    strip?: number | undefined;
 
     /**
      * Alias for strip.
      */
-    'strip-components'?: number;
+    'strip-components'?: number | undefined;
 
     /**
      * Alias for strip.
      */
-    stripComponents?: number;
+    stripComponents?: number | undefined;
 
     /**
      * If true, tar will set the uid and gid of extracted entries to the uid
@@ -444,12 +457,12 @@ export interface ExtractOptions {
      * never unpacked in this implementation, and modes
      * are set by default already.
      */
-    preserveOwner?: boolean;
+    preserveOwner?: boolean | undefined;
 
     /**
      * Alias for preserveOwner.
      */
-    p?: boolean;
+    p?: boolean | undefined;
 
     /**
      * Set to a number to force ownership of all extracted files and folders,
@@ -457,7 +470,7 @@ export interface ExtractOptions {
      * user id, regardless of the uid field in the archive. Cannot be used
      * along with preserveOwner. Requires also setting a gid option.
      */
-    uid?: number;
+    uid?: number | undefined;
 
     /**
      * Set to a number to force ownership of all extracted files and folders,
@@ -465,15 +478,15 @@ export interface ExtractOptions {
      * group id, regardless of the gid field in the archive. Cannot be used
      * along with preserveOwner. Requires also setting a uid option
      */
-    gid?: number;
+    gid?: number | undefined;
 
     /**
      * Set to true to omit writing mtime value for extracted entries.
      * [Alias: m, no-mtime]
      */
-    noMtime?: boolean;
-    m?: boolean;
-    'no-mtime'?: boolean;
+    noMtime?: boolean | undefined;
+    m?: boolean | undefined;
+    'no-mtime'?: boolean | undefined;
 
     /**
      * Provide a function that takes an entry object, and returns a stream,
@@ -490,36 +503,44 @@ export interface ExtractOptions {
      */
     onentry?(entry: ReadEntry): void;
 
+    /**
+     * Set to true to omit calling `fs.chmod()` to ensure that the extracted file
+     * matches the entry mode. This also suppresses the call to `process.umask()`
+     * to determine the default umask value, since tar will extract with whatever
+     * mode is provided, and let the process `umask` apply normally.
+     */
+    noChmod?: boolean | undefined;
+
     // The following options are mostly internal, but can be modified in some
     // advanced use cases, such as re-using caches between runs.
 
     /**
      * The maximum buffer size for fs.read() operations (in bytes). Defaults to 16 MB.
      */
-    maxReadSize?: number;
+    maxReadSize?: number | undefined;
 
     /**
      * The maximum size of meta entries that is supported. Defaults to 1 MB.
      */
-    maxMetaEntrySize?: number;
+    maxMetaEntrySize?: number | undefined;
 }
 
 export interface ListOptions {
     /**
      * Treat warnings as crash-worthy errors. Default false.
      */
-    strict?: boolean;
+    strict?: boolean | undefined;
 
     /**
      * Extract files relative to the specified directory. Defaults to
      * process.cwd(). If provided, this must exist and must be a directory.
      */
-    cwd?: string;
+    cwd?: string | undefined;
 
     /**
      * Alias for cwd.
      */
-    C?: string;
+    C?: string | undefined;
 
     /**
      * A function that gets called with (path, stat) for each entry being
@@ -537,7 +558,7 @@ export interface ListOptions {
     /**
      * The maximum buffer size for fs.read() operations. Defaults to 16 MB.
      */
-    maxReadSize?: number;
+    maxReadSize?: number | undefined;
 
     /**
      * By default, entry streams are resumed immediately after the call to
@@ -545,7 +566,7 @@ export interface ListOptions {
      * opting into this, the stream will never complete until the entry
      * data is consumed.
      */
-    noResume?: boolean;
+    noResume?: boolean | undefined;
 }
 
 export interface ReplaceOptions {
@@ -558,7 +579,7 @@ export interface ReplaceOptions {
      * Act synchronously. If this is set, then any provided file will be
      * fully written after the call to tar.c.
      */
-    sync?: boolean;
+    sync?: boolean | undefined;
 
     /**
      * A function that will get called with (message, data)
@@ -569,29 +590,29 @@ export interface ReplaceOptions {
     /**
      * Treat warnings as crash-worthy errors. Default false.
      */
-    strict?: boolean;
+    strict?: boolean | undefined;
 
     /**
      * Extract files relative to the specified directory. Defaults to
      * process.cwd(). If provided, this must exist and must be a directory.
      */
-    cwd?: string;
+    cwd?: string | undefined;
 
     /**
      * Alias for cwd.
      */
-    C?: string;
+    C?: string | undefined;
 
     /**
      * A path portion to prefix onto the entries in the archive.
      */
-    prefix?: string;
+    prefix?: string | undefined;
 
     /**
      * Set to any truthy value to create a gzipped archive,
      * or an object with settings for zlib.Gzip()
      */
-    gzip?: boolean | zlib.ZlibOptions;
+    gzip?: boolean | zlib.ZlibOptions | undefined;
 
     /**
      * A function that gets called with (path, stat) for each entry being
@@ -602,52 +623,52 @@ export interface ReplaceOptions {
     /**
      * Allow absolute paths. By default, / is stripped from absolute paths.
      */
-    preservePaths?: boolean;
+    preservePaths?: boolean | undefined;
 
     /**
      * The maximum buffer size for fs.read() operations. Defaults to 16 MB.
      */
-    maxReadSize?: number;
+    maxReadSize?: number | undefined;
 
     /**
      * Do not recursively archive the contents of directories.
      */
-    noDirRecurse?: boolean;
+    noDirRecurse?: boolean | undefined;
 
     /**
      * Set to true to pack the targets of symbolic links. Without this
      * option, symbolic links are archived as such.
      */
-    follow?: boolean;
+    follow?: boolean | undefined;
 
     /**
      * Alias for follow.
      */
-    L?: boolean;
+    L?: boolean | undefined;
 
     /**
      * Alias for follow.
      */
-    h?: boolean;
+    h?: boolean | undefined;
 
     /**
      * uppress pax extended headers. Note that this means that long paths and
      * linkpaths will be truncated, and large or negative numeric values
      * may be interpreted incorrectly.
      */
-    noPax?: boolean;
+    noPax?: boolean | undefined;
 }
 
 export interface FileOptions {
     /**
      * Uses the given file as the input or output of this function.
      */
-    file?: string;
+    file?: string | undefined;
 
     /**
      * Alias for file.
      */
-    f?: string;
+    f?: string | undefined;
 }
 
 /**
@@ -658,7 +679,11 @@ export interface FileOptions {
  *
  * Archive data may be read from the returned stream.
  */
-export function create(options: CreateOptions, fileList: ReadonlyArray<string>, callback?: (err?: Error) => void): stream.Readable;
+export function create(
+    options: CreateOptions,
+    fileList: ReadonlyArray<string>,
+    callback?: (err?: Error) => void,
+): stream.Readable;
 
 /**
  * Create a tarball archive. The fileList is an array of paths to add to the
@@ -668,7 +693,11 @@ export function create(options: CreateOptions, fileList: ReadonlyArray<string>,
  */
 export function create(options: CreateOptions & FileOptions, fileList: ReadonlyArray<string>): Promise<void>;
 export function create(options: CreateOptions & FileOptions & { sync: true }, fileList: ReadonlyArray<string>): void;
-export function create(options: CreateOptions & FileOptions, fileList: ReadonlyArray<string>, callback: (err?: Error) => void): void;
+export function create(
+    options: CreateOptions & FileOptions,
+    fileList: ReadonlyArray<string>,
+    callback: (err?: Error) => void,
+): void;
 
 /**
  * Alias for create
@@ -687,7 +716,11 @@ export const c: typeof create;
  *
  * Archive data should be written to the returned stream.
  */
-export function extract(options: ExtractOptions, fileList?: ReadonlyArray<string>, callback?: (err?: Error) => void): stream.Writable;
+export function extract(
+    options: ExtractOptions,
+    fileList?: ReadonlyArray<string>,
+    callback?: (err?: Error) => void,
+): stream.Writable;
 
 /**
  * Extract a tarball archive. The fileList is an array of paths to extract
@@ -701,7 +734,11 @@ export function extract(options: ExtractOptions, fileList?: ReadonlyArray<string
  */
 export function extract(options: ExtractOptions & FileOptions, fileList?: ReadonlyArray<string>): Promise<void>;
 export function extract(options: ExtractOptions & FileOptions & { sync: true }, fileList?: ReadonlyArray<string>): void;
-export function extract(options: ExtractOptions & FileOptions, fileList: ReadonlyArray<string> | undefined, callback: (err?: Error) => void): void;
+export function extract(
+    options: ExtractOptions & FileOptions,
+    fileList: ReadonlyArray<string> | undefined,
+    callback: (err?: Error) => void,
+): void;
 
 /**
  * Alias for extract
@@ -716,7 +753,11 @@ export const x: typeof extract;
  *
  * Archive data should be written to the returned stream.
  */
-export function list(options?: ListOptions, fileList?: ReadonlyArray<string>, callback?: (err?: Error) => void): stream.Writable;
+export function list(
+    options?: ListOptions & FileOptions,
+    fileList?: ReadonlyArray<string>,
+    callback?: (err?: Error) => void,
+): stream.Writable;
 
 /**
  * List the contents of a tarball archive. The fileList is an array of paths
@@ -741,7 +782,11 @@ export const t: typeof list;
  * starts with @, prepend it with ./.
  */
 export function replace(options: ReplaceOptions, fileList?: ReadonlyArray<string>): Promise<void>;
-export function replace(options: ReplaceOptions, fileList: ReadonlyArray<string> | undefined, callback: (err?: Error) => void): Promise<void>;
+export function replace(
+    options: ReplaceOptions,
+    fileList: ReadonlyArray<string> | undefined,
+    callback: (err?: Error) => void,
+): Promise<void>;
 
 /**
  * Alias for replace
@@ -756,7 +801,11 @@ export const r: typeof replace;
  * To add a file that starts with @, prepend it with ./.
  */
 export function update(options: ReplaceOptions, fileList?: ReadonlyArray<string>): Promise<void>;
-export function update(options: ReplaceOptions, fileList: ReadonlyArray<string> | undefined, callback: (err?: Error) => void): Promise<void>;
+export function update(
+    options: ReplaceOptions,
+    fileList: ReadonlyArray<string> | undefined,
+    callback: (err?: Error) => void,
+): Promise<void>;
 
 /**
  * Alias for update

tar/package.json

@@ -1,7 +1,8 @@
 {
     "name": "@types/tar",
-    "version": "4.0.3",
+    "version": "6.1.1",
     "description": "TypeScript definitions for tar",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar",
     "license": "MIT",
     "contributors": [
         {
@@ -16,7 +17,7 @@
         }
     ],
     "main": "",
-    "types": "index",
+    "types": "index.d.ts",
     "repository": {
         "type": "git",
         "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
@@ -27,6 +28,6 @@
         "@types/minipass": "*",
         "@types/node": "*"
     },
-    "typesPublisherContentHash": "3153dd22505c6c845ae3b160de2304faee264aedd2b4b10af8894c76a3d80a02",
-    "typeScriptVersion": "2.0"
+    "typesPublisherContentHash": "b6e3e62eb97754081bd85e908ecdd88b5f90caea3d29212e8624995f91f24321",
+    "typeScriptVersion": "3.8"
 }