@types/tar 6.1.1 → 6.1.3
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.
- tar/README.md +1 -1
- tar/index.d.ts +18 -17
- tar/package.json +5 -5
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:
|
|
11
|
+
* Last updated: Mon, 26 Sep 2022 19:33:06 GMT
|
|
12
12
|
* Dependencies: [@types/minipass](https://npmjs.com/package/@types/minipass), [@types/node](https://npmjs.com/package/@types/node)
|
|
13
13
|
* Global values: none
|
|
14
14
|
|
tar/index.d.ts
CHANGED
|
@@ -553,7 +553,7 @@ export interface ListOptions {
|
|
|
553
553
|
* filter. This is important for when both file and sync are set, because
|
|
554
554
|
* it will be called synchronously.
|
|
555
555
|
*/
|
|
556
|
-
onentry?(entry:
|
|
556
|
+
onentry?(entry: ReadEntry): void;
|
|
557
557
|
|
|
558
558
|
/**
|
|
559
559
|
* The maximum buffer size for fs.read() operations. Defaults to 16 MB.
|
|
@@ -671,6 +671,18 @@ export interface FileOptions {
|
|
|
671
671
|
f?: string | undefined;
|
|
672
672
|
}
|
|
673
673
|
|
|
674
|
+
export type RequiredFileOptions = {
|
|
675
|
+
/**
|
|
676
|
+
* Uses the given file as the input or output of this function.
|
|
677
|
+
*/
|
|
678
|
+
file: string;
|
|
679
|
+
} | {
|
|
680
|
+
/**
|
|
681
|
+
* Alias for file.
|
|
682
|
+
*/
|
|
683
|
+
f: string;
|
|
684
|
+
};
|
|
685
|
+
|
|
674
686
|
/**
|
|
675
687
|
* Create a tarball archive. The fileList is an array of paths to add to the
|
|
676
688
|
* tarball. Adding a directory also adds its children recursively. An entry in
|
|
@@ -745,28 +757,17 @@ export function extract(
|
|
|
745
757
|
*/
|
|
746
758
|
export const x: typeof extract;
|
|
747
759
|
|
|
748
|
-
/**
|
|
749
|
-
* List the contents of a tarball archive. The fileList is an array of paths
|
|
750
|
-
* to list from the tarball. If no paths are provided, then all the entries
|
|
751
|
-
* are listed. If the archive is gzipped, then tar will detect this and unzip
|
|
752
|
-
* it.
|
|
753
|
-
*
|
|
754
|
-
* Archive data should be written to the returned stream.
|
|
755
|
-
*/
|
|
756
|
-
export function list(
|
|
757
|
-
options?: ListOptions & FileOptions,
|
|
758
|
-
fileList?: ReadonlyArray<string>,
|
|
759
|
-
callback?: (err?: Error) => void,
|
|
760
|
-
): stream.Writable;
|
|
761
|
-
|
|
762
760
|
/**
|
|
763
761
|
* List the contents of a tarball archive. The fileList is an array of paths
|
|
764
762
|
* to list from the tarball. If no paths are provided, then all the entries
|
|
765
763
|
* are listed. If the archive is gzipped, then tar will detect this and unzip
|
|
766
764
|
* it.
|
|
767
765
|
*/
|
|
768
|
-
export function list(options: ListOptions &
|
|
769
|
-
export function list(options: ListOptions &
|
|
766
|
+
export function list(options: ListOptions & RequiredFileOptions, fileList?: ReadonlyArray<string>): Promise<void>;
|
|
767
|
+
export function list(options: ListOptions & RequiredFileOptions & { sync: true }, fileList?: ReadonlyArray<string>): void;
|
|
768
|
+
export function list(callback?: (err?: Error) => void): Parse;
|
|
769
|
+
export function list(optionsOrFileList: ListOptions | ReadonlyArray<string>, callback?: (err?: Error) => void): Parse;
|
|
770
|
+
export function list(options: ListOptions, fileList: ReadonlyArray<string>, callback?: (err?: Error) => void): Parse;
|
|
770
771
|
|
|
771
772
|
/**
|
|
772
773
|
* Alias for list
|
tar/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/tar",
|
|
3
|
-
"version": "6.1.
|
|
3
|
+
"version": "6.1.3",
|
|
4
4
|
"description": "TypeScript definitions for tar",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar",
|
|
6
6
|
"license": "MIT",
|
|
@@ -25,9 +25,9 @@
|
|
|
25
25
|
},
|
|
26
26
|
"scripts": {},
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@types/
|
|
29
|
-
"
|
|
28
|
+
"@types/node": "*",
|
|
29
|
+
"minipass": "^3.3.5"
|
|
30
30
|
},
|
|
31
|
-
"typesPublisherContentHash": "
|
|
32
|
-
"typeScriptVersion": "
|
|
31
|
+
"typesPublisherContentHash": "73d2759e05ef82c75abf82485bcfc9688944e454f3ab49a061586d8a42e1fec8",
|
|
32
|
+
"typeScriptVersion": "4.1"
|
|
33
33
|
}
|