@types/tar 4.0.4 → 4.0.5
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/LICENSE +0 -0
- tar/README.md +1 -1
- tar/index.d.ts +72 -72
- tar/package.json +4 -3
tar/LICENSE
CHANGED
|
File without changes
|
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: Fri, 02 Jul 2021 21:32:11 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
|
@@ -15,24 +15,24 @@ import MiniPass = require('minipass');
|
|
|
15
15
|
|
|
16
16
|
export interface HeaderProperties {
|
|
17
17
|
path: string;
|
|
18
|
-
mode?: number;
|
|
19
|
-
noProprietary?: boolean;
|
|
20
|
-
uid?: number;
|
|
21
|
-
gid?: number;
|
|
22
|
-
size?: number;
|
|
23
|
-
mtime?: number;
|
|
24
|
-
type?: string;
|
|
25
|
-
uname?: string;
|
|
26
|
-
gname?: string;
|
|
27
|
-
devmaj?: number;
|
|
28
|
-
devmin?: number;
|
|
18
|
+
mode?: number | undefined;
|
|
19
|
+
noProprietary?: boolean | undefined;
|
|
20
|
+
uid?: number | undefined;
|
|
21
|
+
gid?: number | undefined;
|
|
22
|
+
size?: number | undefined;
|
|
23
|
+
mtime?: number | undefined;
|
|
24
|
+
type?: string | undefined;
|
|
25
|
+
uname?: string | undefined;
|
|
26
|
+
gname?: string | undefined;
|
|
27
|
+
devmaj?: number | undefined;
|
|
28
|
+
devmin?: number | undefined;
|
|
29
29
|
}
|
|
30
30
|
|
|
31
31
|
export interface ExtractOptions {
|
|
32
|
-
type?: string;
|
|
33
|
-
Directory?: boolean;
|
|
34
|
-
path?: string;
|
|
35
|
-
strip?: number;
|
|
32
|
+
type?: string | undefined;
|
|
33
|
+
Directory?: boolean | undefined;
|
|
34
|
+
path?: string | undefined;
|
|
35
|
+
strip?: number | undefined;
|
|
36
36
|
}
|
|
37
37
|
|
|
38
38
|
export interface ParseStream extends NodeJS.ReadWriteStream {
|
|
@@ -264,28 +264,28 @@ export interface CreateOptions {
|
|
|
264
264
|
/**
|
|
265
265
|
* Treat warnings as crash-worthy errors. Default false.
|
|
266
266
|
*/
|
|
267
|
-
strict?: boolean;
|
|
267
|
+
strict?: boolean | undefined;
|
|
268
268
|
|
|
269
269
|
/**
|
|
270
270
|
* The current working directory for creating the archive. Defaults to process.cwd().
|
|
271
271
|
*/
|
|
272
|
-
cwd?: string;
|
|
272
|
+
cwd?: string | undefined;
|
|
273
273
|
|
|
274
274
|
/**
|
|
275
275
|
* Alias for cwd.
|
|
276
276
|
*/
|
|
277
|
-
C?: string;
|
|
277
|
+
C?: string | undefined;
|
|
278
278
|
|
|
279
279
|
/**
|
|
280
280
|
* Set to any truthy value to create a gzipped archive,
|
|
281
281
|
* or an object with settings for zlib.Gzip()
|
|
282
282
|
*/
|
|
283
|
-
gzip?: boolean | zlib.ZlibOptions;
|
|
283
|
+
gzip?: boolean | zlib.ZlibOptions | undefined;
|
|
284
284
|
|
|
285
285
|
/**
|
|
286
286
|
* Alias for gzip.
|
|
287
287
|
*/
|
|
288
|
-
z?: boolean | zlib.ZlibOptions;
|
|
288
|
+
z?: boolean | zlib.ZlibOptions | undefined;
|
|
289
289
|
|
|
290
290
|
/**
|
|
291
291
|
* A function that gets called with (path, stat) for each entry being
|
|
@@ -298,55 +298,55 @@ export interface CreateOptions {
|
|
|
298
298
|
* gname, dev, ino, and nlink. Note that mtime is still included,
|
|
299
299
|
* because this is necessary other time-based operations.
|
|
300
300
|
*/
|
|
301
|
-
portable?: boolean;
|
|
301
|
+
portable?: boolean | undefined;
|
|
302
302
|
|
|
303
303
|
/**
|
|
304
304
|
* Allow absolute paths. By default, / is stripped from absolute paths.
|
|
305
305
|
*/
|
|
306
|
-
preservePaths?: boolean;
|
|
306
|
+
preservePaths?: boolean | undefined;
|
|
307
307
|
|
|
308
308
|
/**
|
|
309
309
|
* Alias for presevePaths.
|
|
310
310
|
*/
|
|
311
|
-
P?: boolean;
|
|
311
|
+
P?: boolean | undefined;
|
|
312
312
|
|
|
313
313
|
/**
|
|
314
314
|
* The mode to set on the created file archive.
|
|
315
315
|
*/
|
|
316
|
-
mode?: number;
|
|
316
|
+
mode?: number | undefined;
|
|
317
317
|
|
|
318
318
|
/**
|
|
319
319
|
* Do not recursively archive the contents of directories.
|
|
320
320
|
*/
|
|
321
|
-
noDirRecurse?: boolean;
|
|
321
|
+
noDirRecurse?: boolean | undefined;
|
|
322
322
|
|
|
323
323
|
/**
|
|
324
324
|
* Set to true to pack the targets of symbolic links. Without this
|
|
325
325
|
* option, symbolic links are archived as such.
|
|
326
326
|
*/
|
|
327
|
-
follow?: boolean;
|
|
327
|
+
follow?: boolean | undefined;
|
|
328
328
|
|
|
329
329
|
/**
|
|
330
330
|
* Alias for follow.
|
|
331
331
|
*/
|
|
332
|
-
L?: boolean;
|
|
332
|
+
L?: boolean | undefined;
|
|
333
333
|
|
|
334
334
|
/**
|
|
335
335
|
* Alias for follow.
|
|
336
336
|
*/
|
|
337
|
-
h?: boolean;
|
|
337
|
+
h?: boolean | undefined;
|
|
338
338
|
|
|
339
339
|
/**
|
|
340
340
|
* Suppress pax extended headers. Note that this means that long paths and
|
|
341
341
|
* linkpaths will be truncated, and large or negative numeric values
|
|
342
342
|
* may be interpreted incorrectly.
|
|
343
343
|
*/
|
|
344
|
-
noPax?: boolean;
|
|
344
|
+
noPax?: boolean | undefined;
|
|
345
345
|
|
|
346
346
|
/**
|
|
347
347
|
* A path portion to prefix onto the entries in the archive.
|
|
348
348
|
*/
|
|
349
|
-
prefix?: string;
|
|
349
|
+
prefix?: string | undefined;
|
|
350
350
|
}
|
|
351
351
|
|
|
352
352
|
export interface ExtractOptions {
|
|
@@ -359,18 +359,18 @@ export interface ExtractOptions {
|
|
|
359
359
|
/**
|
|
360
360
|
* Treat warnings as crash-worthy errors. Default false.
|
|
361
361
|
*/
|
|
362
|
-
strict?: boolean;
|
|
362
|
+
strict?: boolean | undefined;
|
|
363
363
|
|
|
364
364
|
/**
|
|
365
365
|
* Extract files relative to the specified directory. Defaults to
|
|
366
366
|
* process.cwd(). If provided, this must exist and must be a directory.
|
|
367
367
|
*/
|
|
368
|
-
cwd?: string;
|
|
368
|
+
cwd?: string | undefined;
|
|
369
369
|
|
|
370
370
|
/**
|
|
371
371
|
* Alias for cwd.
|
|
372
372
|
*/
|
|
373
|
-
C?: string;
|
|
373
|
+
C?: string | undefined;
|
|
374
374
|
|
|
375
375
|
/**
|
|
376
376
|
* A function that gets called with (path, stat) for each entry being
|
|
@@ -382,33 +382,33 @@ export interface ExtractOptions {
|
|
|
382
382
|
* Set to true to keep the existing file on disk if it's newer than
|
|
383
383
|
* the file in the archive.
|
|
384
384
|
*/
|
|
385
|
-
newer?: boolean;
|
|
385
|
+
newer?: boolean | undefined;
|
|
386
386
|
|
|
387
387
|
/**
|
|
388
388
|
* Alias for newer.
|
|
389
389
|
*/
|
|
390
|
-
'keep-newer'?: boolean;
|
|
390
|
+
'keep-newer'?: boolean | undefined;
|
|
391
391
|
|
|
392
392
|
/**
|
|
393
393
|
* Alias for newer.
|
|
394
394
|
*/
|
|
395
|
-
'keep-newer-files'?: boolean;
|
|
395
|
+
'keep-newer-files'?: boolean | undefined;
|
|
396
396
|
|
|
397
397
|
/**
|
|
398
398
|
* Do not overwrite existing files. In particular, if a file appears more
|
|
399
399
|
* than once in an archive, later copies will not overwrite earlier copies
|
|
400
400
|
*/
|
|
401
|
-
keep?: boolean;
|
|
401
|
+
keep?: boolean | undefined;
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* Alias for keep.
|
|
405
405
|
*/
|
|
406
|
-
k?: boolean;
|
|
406
|
+
k?: boolean | undefined;
|
|
407
407
|
|
|
408
408
|
/**
|
|
409
409
|
* Alias for keep.
|
|
410
410
|
*/
|
|
411
|
-
'keep-existing'?: boolean;
|
|
411
|
+
'keep-existing'?: boolean | undefined;
|
|
412
412
|
|
|
413
413
|
/**
|
|
414
414
|
* Unlink files before creating them. Without this option, tar overwrites
|
|
@@ -416,24 +416,24 @@ export interface ExtractOptions {
|
|
|
416
416
|
* existing hardlinks will be broken, as will any symlink that would
|
|
417
417
|
* affect the location of an extracted file.
|
|
418
418
|
*/
|
|
419
|
-
unlink?: boolean;
|
|
419
|
+
unlink?: boolean | undefined;
|
|
420
420
|
|
|
421
421
|
/**
|
|
422
422
|
* Remove the specified number of leading path elements. Pathnames with
|
|
423
423
|
* fewer elements will be silently skipped. Note that the pathname
|
|
424
424
|
* is edited after applying the filter, but before security checks.
|
|
425
425
|
*/
|
|
426
|
-
strip?: number;
|
|
426
|
+
strip?: number | undefined;
|
|
427
427
|
|
|
428
428
|
/**
|
|
429
429
|
* Alias for strip.
|
|
430
430
|
*/
|
|
431
|
-
'strip-components'?: number;
|
|
431
|
+
'strip-components'?: number | undefined;
|
|
432
432
|
|
|
433
433
|
/**
|
|
434
434
|
* Alias for strip.
|
|
435
435
|
*/
|
|
436
|
-
stripComponents?: number;
|
|
436
|
+
stripComponents?: number | undefined;
|
|
437
437
|
|
|
438
438
|
/**
|
|
439
439
|
* If true, tar will set the uid and gid of extracted entries to the uid
|
|
@@ -444,12 +444,12 @@ export interface ExtractOptions {
|
|
|
444
444
|
* never unpacked in this implementation, and modes
|
|
445
445
|
* are set by default already.
|
|
446
446
|
*/
|
|
447
|
-
preserveOwner?: boolean;
|
|
447
|
+
preserveOwner?: boolean | undefined;
|
|
448
448
|
|
|
449
449
|
/**
|
|
450
450
|
* Alias for preserveOwner.
|
|
451
451
|
*/
|
|
452
|
-
p?: boolean;
|
|
452
|
+
p?: boolean | undefined;
|
|
453
453
|
|
|
454
454
|
/**
|
|
455
455
|
* Set to a number to force ownership of all extracted files and folders,
|
|
@@ -457,7 +457,7 @@ export interface ExtractOptions {
|
|
|
457
457
|
* user id, regardless of the uid field in the archive. Cannot be used
|
|
458
458
|
* along with preserveOwner. Requires also setting a gid option.
|
|
459
459
|
*/
|
|
460
|
-
uid?: number;
|
|
460
|
+
uid?: number | undefined;
|
|
461
461
|
|
|
462
462
|
/**
|
|
463
463
|
* Set to a number to force ownership of all extracted files and folders,
|
|
@@ -465,15 +465,15 @@ export interface ExtractOptions {
|
|
|
465
465
|
* group id, regardless of the gid field in the archive. Cannot be used
|
|
466
466
|
* along with preserveOwner. Requires also setting a uid option
|
|
467
467
|
*/
|
|
468
|
-
gid?: number;
|
|
468
|
+
gid?: number | undefined;
|
|
469
469
|
|
|
470
470
|
/**
|
|
471
471
|
* Set to true to omit writing mtime value for extracted entries.
|
|
472
472
|
* [Alias: m, no-mtime]
|
|
473
473
|
*/
|
|
474
|
-
noMtime?: boolean;
|
|
475
|
-
m?: boolean;
|
|
476
|
-
'no-mtime'?: boolean;
|
|
474
|
+
noMtime?: boolean | undefined;
|
|
475
|
+
m?: boolean | undefined;
|
|
476
|
+
'no-mtime'?: boolean | undefined;
|
|
477
477
|
|
|
478
478
|
/**
|
|
479
479
|
* Provide a function that takes an entry object, and returns a stream,
|
|
@@ -496,30 +496,30 @@ export interface ExtractOptions {
|
|
|
496
496
|
/**
|
|
497
497
|
* The maximum buffer size for fs.read() operations (in bytes). Defaults to 16 MB.
|
|
498
498
|
*/
|
|
499
|
-
maxReadSize?: number;
|
|
499
|
+
maxReadSize?: number | undefined;
|
|
500
500
|
|
|
501
501
|
/**
|
|
502
502
|
* The maximum size of meta entries that is supported. Defaults to 1 MB.
|
|
503
503
|
*/
|
|
504
|
-
maxMetaEntrySize?: number;
|
|
504
|
+
maxMetaEntrySize?: number | undefined;
|
|
505
505
|
}
|
|
506
506
|
|
|
507
507
|
export interface ListOptions {
|
|
508
508
|
/**
|
|
509
509
|
* Treat warnings as crash-worthy errors. Default false.
|
|
510
510
|
*/
|
|
511
|
-
strict?: boolean;
|
|
511
|
+
strict?: boolean | undefined;
|
|
512
512
|
|
|
513
513
|
/**
|
|
514
514
|
* Extract files relative to the specified directory. Defaults to
|
|
515
515
|
* process.cwd(). If provided, this must exist and must be a directory.
|
|
516
516
|
*/
|
|
517
|
-
cwd?: string;
|
|
517
|
+
cwd?: string | undefined;
|
|
518
518
|
|
|
519
519
|
/**
|
|
520
520
|
* Alias for cwd.
|
|
521
521
|
*/
|
|
522
|
-
C?: string;
|
|
522
|
+
C?: string | undefined;
|
|
523
523
|
|
|
524
524
|
/**
|
|
525
525
|
* A function that gets called with (path, stat) for each entry being
|
|
@@ -537,7 +537,7 @@ export interface ListOptions {
|
|
|
537
537
|
/**
|
|
538
538
|
* The maximum buffer size for fs.read() operations. Defaults to 16 MB.
|
|
539
539
|
*/
|
|
540
|
-
maxReadSize?: number;
|
|
540
|
+
maxReadSize?: number | undefined;
|
|
541
541
|
|
|
542
542
|
/**
|
|
543
543
|
* By default, entry streams are resumed immediately after the call to
|
|
@@ -545,7 +545,7 @@ export interface ListOptions {
|
|
|
545
545
|
* opting into this, the stream will never complete until the entry
|
|
546
546
|
* data is consumed.
|
|
547
547
|
*/
|
|
548
|
-
noResume?: boolean;
|
|
548
|
+
noResume?: boolean | undefined;
|
|
549
549
|
}
|
|
550
550
|
|
|
551
551
|
export interface ReplaceOptions {
|
|
@@ -558,7 +558,7 @@ export interface ReplaceOptions {
|
|
|
558
558
|
* Act synchronously. If this is set, then any provided file will be
|
|
559
559
|
* fully written after the call to tar.c.
|
|
560
560
|
*/
|
|
561
|
-
sync?: boolean;
|
|
561
|
+
sync?: boolean | undefined;
|
|
562
562
|
|
|
563
563
|
/**
|
|
564
564
|
* A function that will get called with (message, data)
|
|
@@ -569,29 +569,29 @@ export interface ReplaceOptions {
|
|
|
569
569
|
/**
|
|
570
570
|
* Treat warnings as crash-worthy errors. Default false.
|
|
571
571
|
*/
|
|
572
|
-
strict?: boolean;
|
|
572
|
+
strict?: boolean | undefined;
|
|
573
573
|
|
|
574
574
|
/**
|
|
575
575
|
* Extract files relative to the specified directory. Defaults to
|
|
576
576
|
* process.cwd(). If provided, this must exist and must be a directory.
|
|
577
577
|
*/
|
|
578
|
-
cwd?: string;
|
|
578
|
+
cwd?: string | undefined;
|
|
579
579
|
|
|
580
580
|
/**
|
|
581
581
|
* Alias for cwd.
|
|
582
582
|
*/
|
|
583
|
-
C?: string;
|
|
583
|
+
C?: string | undefined;
|
|
584
584
|
|
|
585
585
|
/**
|
|
586
586
|
* A path portion to prefix onto the entries in the archive.
|
|
587
587
|
*/
|
|
588
|
-
prefix?: string;
|
|
588
|
+
prefix?: string | undefined;
|
|
589
589
|
|
|
590
590
|
/**
|
|
591
591
|
* Set to any truthy value to create a gzipped archive,
|
|
592
592
|
* or an object with settings for zlib.Gzip()
|
|
593
593
|
*/
|
|
594
|
-
gzip?: boolean | zlib.ZlibOptions;
|
|
594
|
+
gzip?: boolean | zlib.ZlibOptions | undefined;
|
|
595
595
|
|
|
596
596
|
/**
|
|
597
597
|
* A function that gets called with (path, stat) for each entry being
|
|
@@ -602,52 +602,52 @@ export interface ReplaceOptions {
|
|
|
602
602
|
/**
|
|
603
603
|
* Allow absolute paths. By default, / is stripped from absolute paths.
|
|
604
604
|
*/
|
|
605
|
-
preservePaths?: boolean;
|
|
605
|
+
preservePaths?: boolean | undefined;
|
|
606
606
|
|
|
607
607
|
/**
|
|
608
608
|
* The maximum buffer size for fs.read() operations. Defaults to 16 MB.
|
|
609
609
|
*/
|
|
610
|
-
maxReadSize?: number;
|
|
610
|
+
maxReadSize?: number | undefined;
|
|
611
611
|
|
|
612
612
|
/**
|
|
613
613
|
* Do not recursively archive the contents of directories.
|
|
614
614
|
*/
|
|
615
|
-
noDirRecurse?: boolean;
|
|
615
|
+
noDirRecurse?: boolean | undefined;
|
|
616
616
|
|
|
617
617
|
/**
|
|
618
618
|
* Set to true to pack the targets of symbolic links. Without this
|
|
619
619
|
* option, symbolic links are archived as such.
|
|
620
620
|
*/
|
|
621
|
-
follow?: boolean;
|
|
621
|
+
follow?: boolean | undefined;
|
|
622
622
|
|
|
623
623
|
/**
|
|
624
624
|
* Alias for follow.
|
|
625
625
|
*/
|
|
626
|
-
L?: boolean;
|
|
626
|
+
L?: boolean | undefined;
|
|
627
627
|
|
|
628
628
|
/**
|
|
629
629
|
* Alias for follow.
|
|
630
630
|
*/
|
|
631
|
-
h?: boolean;
|
|
631
|
+
h?: boolean | undefined;
|
|
632
632
|
|
|
633
633
|
/**
|
|
634
634
|
* uppress pax extended headers. Note that this means that long paths and
|
|
635
635
|
* linkpaths will be truncated, and large or negative numeric values
|
|
636
636
|
* may be interpreted incorrectly.
|
|
637
637
|
*/
|
|
638
|
-
noPax?: boolean;
|
|
638
|
+
noPax?: boolean | undefined;
|
|
639
639
|
}
|
|
640
640
|
|
|
641
641
|
export interface FileOptions {
|
|
642
642
|
/**
|
|
643
643
|
* Uses the given file as the input or output of this function.
|
|
644
644
|
*/
|
|
645
|
-
file?: string;
|
|
645
|
+
file?: string | undefined;
|
|
646
646
|
|
|
647
647
|
/**
|
|
648
648
|
* Alias for file.
|
|
649
649
|
*/
|
|
650
|
-
f?: string;
|
|
650
|
+
f?: string | undefined;
|
|
651
651
|
}
|
|
652
652
|
|
|
653
653
|
/**
|
tar/package.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/tar",
|
|
3
|
-
"version": "4.0.
|
|
3
|
+
"version": "4.0.5",
|
|
4
4
|
"description": "TypeScript definitions for tar",
|
|
5
|
+
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar",
|
|
5
6
|
"license": "MIT",
|
|
6
7
|
"contributors": [
|
|
7
8
|
{
|
|
@@ -27,6 +28,6 @@
|
|
|
27
28
|
"@types/minipass": "*",
|
|
28
29
|
"@types/node": "*"
|
|
29
30
|
},
|
|
30
|
-
"typesPublisherContentHash": "
|
|
31
|
-
"typeScriptVersion": "3.
|
|
31
|
+
"typesPublisherContentHash": "a6efdc2394562ab1a73de84074e183b53ab21d470ff13ecf93b28ba3993bd3d7",
|
|
32
|
+
"typeScriptVersion": "3.6"
|
|
32
33
|
}
|