@types/tar 6.1.2 → 6.1.4

tar/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for tar (https://github.com/npm/node-tar)
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar.
 
 ### Additional Details
- * Last updated: Mon, 01 Aug 2022 22:02:17 GMT
+ * Last updated: Thu, 16 Feb 2023 06:02:34 GMT
  * Dependencies: [@types/minipass](https://npmjs.com/package/@types/minipass), [@types/node](https://npmjs.com/package/@types/node)
  * Global values: none
 

tar/index.d.ts

@@ -7,7 +7,6 @@
 /// <reference types="node" />
 
 import stream = require('stream');
-import events = require('events');
 import zlib = require('zlib');
 import MiniPass = require('minipass');
 
@@ -213,18 +212,146 @@ export interface Parse extends ParseStream {
 }
 
 export const Parse: {
-    new(opt?: ParseOptions): Parse;
+    new (opt?: ParseOptions): Parse;
 };
 //#endregion
 
 //#region Global Methods
 
+export interface PackOptions {
+    /**
+     * A function that will get called with (code, message, data) for any
+     * warnings encountered. (See "Warnings and Errors")
+     */
+    onwarn?(code: string, message: string, data: Buffer): void;
+    /**
+     * Treat warnings as crash-worthy errors.
+     *
+     * @default false
+     */
+    strict?: boolean;
+    /**
+     * The current working directory for creating the archive.
+     *
+     * @default process.cwd()
+     */
+    cwd?: string[];
+    /**
+     * A path portion to prefix onto the entries in the archive.
+     */
+    prefix?: string;
+    /**
+     * Set to any truthy value to create a gzipped archive, or an object with
+     * settings for zlib.Gzip()
+     */
+    gzip?: boolean | zlib.ZlibOptions;
+    /**
+     * A function that gets called with (path, stat) for each entry being added.
+     * Return true to add the entry to the archive, or false to omit it.
+     */
+    filter?(path: string, stat: FileStat): boolean;
+    /**
+     * Omit metadata that is system-specific: ctime, atime, uid, gid, uname,
+     * gname, dev, ino, and nlink. Note that mtime is still included, because
+     * this is necessary for other time-based operations. Additionally, mode is
+     * set to a "reasonable default" for most unix systems, based on a umask
+     * value of 0o22.
+     */
+    portable?: boolean;
+    /**
+     * Allow absolute paths. By default, / is stripped from absolute paths.
+     */
+    preservePaths?: boolean;
+    /**
+     * A Map object containing the device and inode value for any file whose
+     * nlink is > 1, to identify hard links.
+     */
+    linkCache?: Map<string, string>;
+    /**
+     * A Map object that caches calls lstat.
+     */
+    statCache?: Map<string, string>;
+    /**
+     * A Map object that caches calls to readdir.
+     */
+    readdirCache?: Map<string, string>;
+    /**
+     * A number specifying how many concurrent jobs to run.
+     *
+     * @default 4
+     */
+    jobs?: number;
+    /**
+     * The maximum buffer size for fs.read() operations.
+     *
+     * @default 16 MB
+     */
+    maxReadSize?: number;
+    /**
+     * Do not recursively archive the contents of directories.
+     */
+    noDirRecurse?: boolean;
+    /**
+     * Set to true to pack the targets of symbolic links. Without this option,
+     * symbolic links are archived as such.
+     */
+    follow?: boolean;
+    /**
+     * 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;
+    /**
+     * Set to true to omit writing mtime values for entries. Note that this
+     * prevents using other mtime-based features like tar.update or the
+     * keepNewer option with the resulting tar archive.
+     */
+    noMtime?: boolean;
+    /**
+     * Set to a Date object to force a specific mtime for everything added to
+     * the archive. Overridden by noMtime.
+     */
+    mtime?: number;
+}
+
 /**
  * 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.
  * The optional properties object are used to set properties in the tar 'Global Extended Header'.
  */
-export function Pack(props?: HeaderProperties): PackStream;
+export class Pack extends MiniPass {
+    linkCache: PackOptions['linkCache'];
+    readdirCache: PackOptions['readdirCache'];
+    statCache: PackOptions['statCache'];
+
+    static Sync: typeof PackSync;
+
+    constructor(opt?: PackOptions);
+
+    add(path: string): this;
+}
+
+declare class PackSync extends Pack {
+    constructor(opt: PackOptions);
+
+    // pause/resume are no-ops in sync streams.
+    pause(): void;
+    resume(): void;
+}
+
+declare class PackJob {
+    path: string;
+    absolute: string;
+    entry: unknown | null;
+    stat: unknown | null;
+    readdir: unknown | null;
+    pending: boolean;
+    ignore: boolean;
+    piped: boolean;
+
+    constructor(path?: string, absolute?: string);
+}
 
 /**
  * Returns a through stream. Write tar data to the stream and the files in the tarball will be extracted onto the filesystem.
@@ -553,7 +680,7 @@ export interface ListOptions {
      * filter. This is important for when both file and sync are set, because
      * it will be called synchronously.
      */
-    onentry?(entry: FileStat): void;
+    onentry?(entry: ReadEntry): void;
 
     /**
      * The maximum buffer size for fs.read() operations. Defaults to 16 MB.
@@ -671,6 +798,18 @@ export interface FileOptions {
     f?: string | undefined;
 }
 
+export type RequiredFileOptions = {
+    /**
+     * Uses the given file as the input or output of this function.
+     */
+    file: string;
+} | {
+    /**
+     * Alias for file.
+     */
+    f: string;
+};
+
 /**
  * Create a tarball archive. The fileList is an array of paths to add to the
  * tarball. Adding a directory also adds its children recursively. An entry in
@@ -745,28 +884,17 @@ export function extract(
  */
 export const x: typeof extract;
 
-/**
- * List the contents of a tarball archive. The fileList is an array of paths
- * to list from the tarball. If no paths are provided, then all the entries
- * are listed. If the archive is gzipped, then tar will detect this and unzip
- * it.
- *
- * Archive data should be written to the returned stream.
- */
-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
  * to list from the tarball. If no paths are provided, then all the entries
  * are listed. If the archive is gzipped, then tar will detect this and unzip
  * it.
  */
-export function list(options: ListOptions & FileOptions, fileList?: ReadonlyArray<string>): Promise<void>;
-export function list(options: ListOptions & FileOptions & { sync: true }, fileList?: ReadonlyArray<string>): void;
+export function list(options: ListOptions & RequiredFileOptions, fileList?: ReadonlyArray<string>): Promise<void>;
+export function list(options: ListOptions & RequiredFileOptions & { sync: true }, fileList?: ReadonlyArray<string>): void;
+export function list(callback?: (err?: Error) => void): Parse;
+export function list(optionsOrFileList: ListOptions | ReadonlyArray<string>, callback?: (err?: Error) => void): Parse;
+export function list(options: ListOptions, fileList: ReadonlyArray<string>, callback?: (err?: Error) => void): Parse;
 
 /**
  * Alias for list
@@ -811,3 +939,5 @@ export function update(
  * Alias for update
  */
 export const u: typeof update;
+
+export {};

tar/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/tar",
-    "version": "6.1.2",
+    "version": "6.1.4",
     "description": "TypeScript definitions for tar",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar",
     "license": "MIT",
@@ -26,8 +26,8 @@
     "scripts": {},
     "dependencies": {
         "@types/node": "*",
-        "minipass": "^3.3.5"
+        "minipass": "^4.0.0"
     },
-    "typesPublisherContentHash": "1ed2a9537078e1f4506663bfa209058cfdcad5f1d6770ed205517e663ec67a8b",
-    "typeScriptVersion": "4.0"
+    "typesPublisherContentHash": "e903d71c2ec53ea8e04cbb1125f7386388c26c9152c68db383d78496fa362b97",
+    "typeScriptVersion": "4.2"
 }