1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
import { IOptions as GlobOptions } from 'glob';
import { Stats } from 'fs';
export type CreateOptions = {
dot?: boolean;
globOptions?: GlobOptions;
ordering?: string;
pattern?: string;
transform?: (filePath: string) => NodeJS.ReadWriteStream | void;
unpack?: string;
unpackDir?: string;
};
export type ListOptions = {
isPack: boolean;
};
export type EntryMetadata = {
unpacked: boolean;
};
export type DirectoryMetadata = EntryMetadata & {
files: { [property: string]: EntryMetadata };
};
export type FileMetadata = EntryMetadata & {
executable?: true;
offset?: number;
size?: number;
};
export type LinkMetadata = {
link: string;
};
export type Metadata = DirectoryMetadata | FileMetadata | LinkMetadata;
export type InputMetadataType = 'directory' | 'file' | 'link';
export type InputMetadata = {
[property: string]: {
type: InputMetadataType;
stat: Stats;
}
};
export type DirectoryRecord = {
files: Record<string, DirectoryRecord | FileRecord>;
};
export type FileRecord = {
offset: string;
size: number;
executable?: boolean;
integrity: {
hash: string;
algorithm: 'SHA256';
blocks: string[];
blockSize: number;
};
}
export type ArchiveHeader = {
// The JSON parsed header string
header: DirectoryRecord;
headerString: string;
headerSize: number;
}
export function createPackage(src: string, dest: string): Promise<void>;
export function createPackageWithOptions(
src: string,
dest: string,
options: CreateOptions
): Promise<void>;
export function createPackageFromFiles(
src: string,
dest: string,
filenames: string[],
metadata?: InputMetadata,
options?: CreateOptions
): Promise<void>;
export function statFile(archive: string, filename: string, followLinks?: boolean): Metadata;
export function getRawHeader(archive: string): ArchiveHeader;
export function listPackage(archive: string, options?: ListOptions): string[];
export function extractFile(archive: string, filename: string): Buffer;
export function extractAll(archive: string, dest: string): void;
export function uncache(archive: string): boolean;
export function uncacheAll(): void;
|
