-
Notifications
You must be signed in to change notification settings - Fork 89
Expand file tree
/
Copy pathdev-container-cli.d.ts
More file actions
59 lines (59 loc) · 2.05 KB
/
dev-container-cli.d.ts
File metadata and controls
59 lines (59 loc) · 2.05 KB
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
import { ExecFunction } from './exec';
export interface DevContainerCliError {
outcome: 'error';
code: number;
message: string;
description: string;
}
declare function isCliInstalled(exec: ExecFunction): Promise<boolean>;
declare function installCli(exec: ExecFunction): Promise<boolean>;
export interface DevContainerCliSuccessResult {
outcome: 'success';
}
export interface DevContainerCliBuildResult extends DevContainerCliSuccessResult {
imageDigests?: Record<string, string>;
}
export interface DevContainerCliBuildArgs {
workspaceFolder: string;
configFile: string | undefined;
imageName?: string[];
platform?: string;
additionalCacheFroms?: string[];
userDataFolder?: string;
output?: string;
noCache?: boolean;
cacheTo?: string[];
}
declare function devContainerBuild(args: DevContainerCliBuildArgs, log: (data: string) => void): Promise<DevContainerCliBuildResult | DevContainerCliError>;
export interface DevContainerCliUpResult extends DevContainerCliSuccessResult {
containerId: string;
remoteUser: string;
remoteWorkspaceFolder: string;
}
export interface DevContainerCliUpArgs {
workspaceFolder: string;
configFile: string | undefined;
additionalCacheFroms?: string[];
cacheTo?: string[];
skipContainerUserIdUpdate?: boolean;
env?: string[];
userDataFolder?: string;
additionalMounts?: string[];
}
declare function devContainerUp(args: DevContainerCliUpArgs, log: (data: string) => void): Promise<DevContainerCliUpResult | DevContainerCliError>;
export interface DevContainerCliExecArgs {
workspaceFolder: string;
configFile: string | undefined;
command: string[];
env?: string[];
userDataFolder?: string;
}
declare function devContainerExec(args: DevContainerCliExecArgs, log: (data: string) => void): Promise<number | null>;
export declare const devcontainer: {
build: typeof devContainerBuild;
up: typeof devContainerUp;
exec: typeof devContainerExec;
isCliInstalled: typeof isCliInstalled;
installCli: typeof installCli;
};
export {};