@types/tar 6.1.11 → 6.1.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. tar/README.md +1 -1
  2. tar/index.d.ts +52 -28
  3. tar/package.json +3 -3
tar/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for tar (https://github.com/npm/node-tar)
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Thu, 25 Jan 2024 07:07:05 GMT
11
+ * Last updated: Thu, 18 Apr 2024 00:23:15 GMT
12
12
  * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [minipass](https://npmjs.com/package/minipass)
13
13
 
14
14
  # Credits
tar/index.d.ts CHANGED
@@ -22,13 +22,6 @@ export interface HeaderProperties {
22
22
  devmin?: number | undefined;
23
23
  }
24
24
 
25
- export interface ExtractOptions {
26
- type?: string | undefined;
27
- Directory?: boolean | undefined;
28
- path?: string | undefined;
29
- strip?: number | undefined;
30
- }
31
-
32
25
  export interface ParseStream extends NodeJS.ReadWriteStream {
33
26
  position: number;
34
27
 
@@ -240,6 +233,11 @@ export interface PackOptions {
240
233
  * settings for zlib.Gzip()
241
234
  */
242
235
  gzip?: boolean | zlib.ZlibOptions;
236
+ /**
237
+ * Set to any truthy value to create a brotli-compressed archive,
238
+ * or an object with settings for zlib.BrotliCompress()
239
+ */
240
+ brotli?: boolean | zlib.BrotliOptions;
243
241
  /**
244
242
  * A function that gets called with (path, stat) for each entry being added.
245
243
  * Return true to add the entry to the archive, or false to omit it.
@@ -422,6 +420,12 @@ export interface CreateOptions {
422
420
  */
423
421
  z?: boolean | zlib.ZlibOptions | undefined;
424
422
 
423
+ /**
424
+ * Set to any truthy value to create a brotli-compressed archive,
425
+ * or an object with settings for zlib.BrotliCompress()
426
+ */
427
+ brotli?: boolean | zlib.BrotliOptions | undefined;
428
+
425
429
  /**
426
430
  * A function that gets called with (path, stat) for each entry being
427
431
  * added. Return true to add the entry to the archive, or false to omit it.
@@ -478,6 +482,19 @@ export interface CreateOptions {
478
482
  */
479
483
  noPax?: boolean | undefined;
480
484
 
485
+ /**
486
+ * Set to true to omit writing mtime values for entries. Note that this prevents using other mtime-based features
487
+ * like `tar.update` or the `keepNewer` option with the resulting tar archive. [Alias: m, no-mtime]
488
+ */
489
+ noMtime?: boolean | undefined;
490
+ m?: boolean | undefined;
491
+ "no-mtime"?: boolean | undefined;
492
+
493
+ /**
494
+ * Set to a Date object to force a specific mtime for everything added to the archive. Overridden by noMtime.
495
+ */
496
+ mtime?: Date;
497
+
481
498
  /**
482
499
  * A path portion to prefix onto the entries in the archive.
483
500
  */
@@ -545,6 +562,20 @@ export interface ExtractOptions {
545
562
  */
546
563
  "keep-existing"?: boolean | undefined;
547
564
 
565
+ /**
566
+ * Allow absolute paths, paths containing .., and extracting
567
+ * through symbolic links. By default, / is stripped from
568
+ * absolute paths, .. paths are not extracted, and any file
569
+ * whose location would be modified by a symbolic link is not
570
+ * extracted.
571
+ */
572
+ preservePaths?: boolean | undefined;
573
+
574
+ /**
575
+ * Alias for presevePaths.
576
+ */
577
+ P?: boolean | undefined;
578
+
548
579
  /**
549
580
  * Unlink files before creating them. Without this option, tar overwrites
550
581
  * existing files, which preserves existing hardlinks. With this option,
@@ -730,12 +761,6 @@ export interface ReplaceOptions {
730
761
  */
731
762
  prefix?: string | undefined;
732
763
 
733
- /**
734
- * Set to any truthy value to create a gzipped archive,
735
- * or an object with settings for zlib.Gzip()
736
- */
737
- gzip?: boolean | zlib.ZlibOptions | undefined;
738
-
739
764
  /**
740
765
  * A function that gets called with (path, stat) for each entry being
741
766
  * added. Return true to emit the entry from the archive, or false to skip it.
@@ -793,17 +818,19 @@ export interface FileOptions {
793
818
  f?: string | undefined;
794
819
  }
795
820
 
796
- export type RequiredFileOptions = {
797
- /**
798
- * Uses the given file as the input or output of this function.
799
- */
800
- file: string;
801
- } | {
802
- /**
803
- * Alias for file.
804
- */
805
- f: string;
806
- };
821
+ export type RequiredFileOptions =
822
+ | {
823
+ /**
824
+ * Uses the given file as the input or output of this function.
825
+ */
826
+ file: string;
827
+ }
828
+ | {
829
+ /**
830
+ * Alias for file.
831
+ */
832
+ f: string;
833
+ };
807
834
 
808
835
  /**
809
836
  * Create a tarball archive. The fileList is an array of paths to add to the
@@ -886,10 +913,7 @@ export const x: typeof extract;
886
913
  * it.
887
914
  */
888
915
  export function list(options: ListOptions & RequiredFileOptions, fileList?: readonly string[]): Promise<void>;
889
- export function list(
890
- options: ListOptions & RequiredFileOptions & { sync: true },
891
- fileList?: readonly string[],
892
- ): void;
916
+ export function list(options: ListOptions & RequiredFileOptions & { sync: true }, fileList?: readonly string[]): void;
893
917
  export function list(callback?: (err?: Error) => void): Parse;
894
918
  export function list(optionsOrFileList: ListOptions | readonly string[], callback?: (err?: Error) => void): Parse;
895
919
  export function list(options: ListOptions, fileList: readonly string[], callback?: (err?: Error) => void): Parse;
tar/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/tar",
3
- "version": "6.1.11",
3
+ "version": "6.1.13",
4
4
  "description": "TypeScript definitions for tar",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar",
6
6
  "license": "MIT",
@@ -28,6 +28,6 @@
28
28
  "@types/node": "*",
29
29
  "minipass": "^4.0.0"
30
30
  },
31
- "typesPublisherContentHash": "189829b574735c37eec5a76be4fbd5dde6e8df5b4042f718532fcb7177a054f4",
32
- "typeScriptVersion": "4.6"
31
+ "typesPublisherContentHash": "21bfcbacede4f9d98d455e762fb5bf22078fee340a2b25bd1241d7a9f8c44784",
32
+ "typeScriptVersion": "4.7"
33
33
  }