@types/tar 4.0.0 → 4.0.4

tar/LICENSE

@@ -1,6 +1,6 @@
     MIT License
 
-    Copyright (c) Microsoft Corporation. All rights reserved.
+    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

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://www.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: Thu, 07 Sep 2017 22:03:13 GMT
- * Dependencies: stream, events, zlib, node
+### Additional Details
+ * Last updated: Wed, 18 Nov 2020 00:19:43 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>, 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

@@ -6,20 +6,22 @@
 
 /// <reference types="node" />
 
-import stream = require("stream");
-import events = require("events");
-import zlib = require("zlib");
+import stream = require('stream');
+import events = require('events');
+import zlib = require('zlib');
+import MiniPass = require('minipass');
 
 // #region Interfaces
 
 export interface HeaderProperties {
-    path?: string;
+    path: string;
     mode?: number;
     noProprietary?: boolean;
     uid?: number;
     gid?: number;
     size?: number;
     mtime?: number;
+    type?: string;
     uname?: string;
     gname?: string;
     devmaj?: number;
@@ -234,6 +236,24 @@ export interface FileStat extends stream.Readable, Fields {
     size: number;
 }
 
+export interface ReadEntry extends MiniPass, HeaderProperties {
+    /** The extended metadata object provided to the constructor. */
+    extended: any;
+    /** The global extended metadata object provided to the constructor. */
+    globalExtended: any;
+    /** The number of bytes remaining to be written into the stream. */
+    remain: number;
+    /** The number of 512-byte blocks remaining to be written into the stream. */
+    blockRemain: number;
+    /** Whether this entry should be ignored. */
+    ignore: boolean;
+    /**
+     * True if this represents metadata about the next entry, false if it
+     * represents a filesystem object.
+     */
+    meta: boolean;
+}
+
 export interface CreateOptions {
     /**
      * A function that will get called with (message, data)
@@ -317,11 +337,16 @@ export interface CreateOptions {
     h?: boolean;
 
     /**
-     * uppress pax extended headers. Note that this means that long paths and
+     * 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;
+
+    /**
+     * A path portion to prefix onto the entries in the archive.
+     */
+    prefix?: string;
 }
 
 export interface ExtractOptions {
@@ -440,7 +465,43 @@ 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
      */
-    gui?: number;
+    gid?: number;
+
+    /**
+     * Set to true to omit writing mtime value for extracted entries.
+     * [Alias: m, no-mtime]
+     */
+    noMtime?: boolean;
+    m?: boolean;
+    'no-mtime'?: boolean;
+
+    /**
+     * Provide a function that takes an entry object, and returns a stream,
+     * or any falsey value. If a stream is provided, then that stream's data
+     * will be written instead of the contents of the archive entry. If a
+     * falsey value is provided, then the entry is written to disk as normal.
+     * (To exclude items from extraction, use the filter option described above.)
+     */
+    transform?(entry: ReadEntry): NodeJS.WritableStream | undefined | false | null;
+
+    /**
+     * A function that gets called with (entry) for each entry that passes the
+     * filter.
+     */
+    onentry?(entry: ReadEntry): void;
+
+    // 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;
+
+    /**
+     * The maximum size of meta entries that is supported. Defaults to 1 MB.
+     */
+    maxMetaEntrySize?: number;
 }
 
 export interface ListOptions {
@@ -655,7 +716,7 @@ 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

tar/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/tar",
-    "version": "4.0.0",
+    "version": "4.0.4",
     "description": "TypeScript definitions for tar",
     "license": "MIT",
     "contributors": [
@@ -16,14 +16,17 @@
         }
     ],
     "main": "",
+    "types": "index.d.ts",
     "repository": {
         "type": "git",
-        "url": "https://www.github.com/DefinitelyTyped/DefinitelyTyped.git"
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/tar"
     },
     "scripts": {},
     "dependencies": {
+        "@types/minipass": "*",
         "@types/node": "*"
     },
-    "typesPublisherContentHash": "649d4deb8bdf19b642627c5b8157c2ce7078a0739c411f8715f90aeed5c157e9",
-    "typeScriptVersion": "2.0"
+    "typesPublisherContentHash": "30d331e61e5cf0331015727fdf7fd167e90c67d9c6f2edcb26a0aab9a4f4dd92",
+    "typeScriptVersion": "3.2"
 }