docker-compose/index.d.ts
2019-04-11 12:10:45 +02:00

51 lines
2.3 KiB
TypeScript

declare module "docker-compose" {
interface IDockerCompose {
upAll(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
upMany(services:String[], options: IDockerComposeOptions): Promise<IDockerComposeResult>;
upOne(service:String, options: IDockerComposeOptions): Promise<IDockerComposeResult>;
kill(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
down(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
stop(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
restartAll(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
restartMany(services:String[], options: IDockerComposeOptions): Promise<IDockerComposeResult>;
restartOne(service:String, options: IDockerComposeOptions): Promise<IDockerComposeResult>;
rm(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
exec(container:String, command:String, options: IDockerComposeOptions): Promise<IDockerComposeResult>;
logs(container:String, command:String, options: IDockerComposeLogOptions): Promise<IDockerComposeResult>;
run(service:String, command:String, options: IDockerComposeOptions): Promise<IDockerComposeResult>;
buildAll(options: IDockerComposeBuildOptions): Promise<IDockerComposeResult>;
buildMany(services:String[], options: IDockerComposeBuildOptions): Promise<IDockerComposeResult>;
buildOne(service:String, options: IDockerComposeOptions): Promise<IDockerComposeResult>;
ps(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
push(options: IDockerComposePushOptions): Promise<IDockerComposeResult>;
port(service:String, containerPort:String|Number, options: IDockerComposeOptions): Promise<IDockerComposeResult>;
}
interface IDockerComposeOptions {
cwd: string;
config?: string | string[];
log?: boolean;
composeOptions?: string[] | Array<string | string[]>;
commandOptions?: string[] | Array<string | string[]>;
}
interface IDockerComposeLogOptions extends IDockerComposeOptions {
follow: boolean;
}
interface IDockerComposeBuildOptions extends IDockerComposeOptions {
parallel?: boolean;
}
interface IDockerComposePushOptions extends IDockerComposeOptions {
ignorePushFailures?: boolean;
}
interface IDockerComposeResult {
out: string;
err: string;
}
const _: IDockerCompose;
export = _;
}