///
export interface IDockerComposeOptions {
cwd?: string;
executablePath?: string;
config?: string | string[];
configAsString?: string;
log?: boolean;
composeOptions?: string[] | (string | string[])[];
commandOptions?: string[] | (string | string[])[];
env?: NodeJS.ProcessEnv;
callback?: (chunk: Buffer, streamSource?: 'stdout' | 'stderr') => void;
}
export type DockerComposePortResult = {
address: string;
port: number;
};
export type DockerComposeVersionResult = {
version: string;
};
export type DockerComposeConfigResult = {
config: {
version: Record;
services: Record>;
volumes: Record;
};
};
export type DockerComposeConfigServicesResult = {
services: string[];
};
export type DockerComposeConfigVolumesResult = {
volumes: string[];
};
export interface IDockerComposeLogOptions extends IDockerComposeOptions {
follow?: boolean;
}
export interface IDockerComposeBuildOptions extends IDockerComposeOptions {
parallel?: boolean;
}
export interface IDockerComposePushOptions extends IDockerComposeOptions {
ignorePushFailures?: boolean;
}
export interface IDockerComposeResult {
exitCode: number | null;
out: string;
err: string;
}
export type TypedDockerComposeResult = {
exitCode: number | null;
out: string;
err: string;
data: T;
};
export type DockerComposePsResult = {
services: Array<{
name: string;
command: string;
state: string;
ports: Array<{
mapped?: {
address: string;
port: number;
};
exposed: {
port: number;
protocol: string;
};
}>;
}>;
};
export declare const mapPsOutput: (output: string, options?: IDockerComposeOptions) => DockerComposePsResult;
/**
* Executes docker-compose command with common options
*/
export declare const execCompose: (command: any, args: any, options?: IDockerComposeOptions) => Promise;
export declare const upAll: (options?: IDockerComposeOptions) => Promise;
export declare const upMany: (services: string[], options?: IDockerComposeOptions) => Promise;
export declare const upOne: (service: string, options?: IDockerComposeOptions) => Promise;
export declare const down: (options?: IDockerComposeOptions) => Promise;
export declare const stop: (options?: IDockerComposeOptions) => Promise;
export declare const stopOne: (service: string, options?: IDockerComposeOptions) => Promise;
export declare const stopMany: (options?: IDockerComposeOptions, ...services: string[]) => Promise;
export declare const pauseOne: (service: string, options?: IDockerComposeOptions) => Promise;
export declare const unpauseOne: (service: string, options?: IDockerComposeOptions) => Promise;
export declare const kill: (options?: IDockerComposeOptions) => Promise;
export declare const rm: (options?: IDockerComposeOptions, ...services: string[]) => Promise;
export declare const exec: (container: string, command: string | string[], options?: IDockerComposeOptions) => Promise;
export declare const run: (container: string, command: string | string[], options?: IDockerComposeOptions) => Promise;
export declare const buildAll: (options?: IDockerComposeBuildOptions) => Promise;
export declare const buildMany: (services: string[], options?: IDockerComposeBuildOptions) => Promise;
export declare const buildOne: (service: string, options?: IDockerComposeBuildOptions) => Promise;
export declare const pullAll: (options?: IDockerComposeOptions) => Promise;
export declare const pullMany: (services: string[], options?: IDockerComposeOptions) => Promise;
export declare const pullOne: (service: string, options?: IDockerComposeOptions) => Promise;
export declare const config: (options?: IDockerComposeOptions) => Promise>;
export declare const configServices: (options?: IDockerComposeOptions) => Promise>;
export declare const configVolumes: (options?: IDockerComposeOptions) => Promise>;
export declare const ps: (options?: IDockerComposeOptions) => Promise>;
export declare const push: (options?: IDockerComposePushOptions) => Promise;
export declare const restartAll: (options?: IDockerComposeOptions) => Promise;
export declare const restartMany: (services: string[], options?: IDockerComposeOptions) => Promise;
export declare const restartOne: (service: string, options?: IDockerComposeOptions) => Promise;
export declare const logs: (services: string | string[], options?: IDockerComposeLogOptions) => Promise;
export declare const port: (service: string, containerPort: string | number, options?: IDockerComposeOptions) => Promise>;
export declare const version: (options?: IDockerComposeOptions) => Promise>;
declare const _default: {
upAll: (options?: IDockerComposeOptions | undefined) => Promise;
upMany: (services: string[], options?: IDockerComposeOptions | undefined) => Promise;
upOne: (service: string, options?: IDockerComposeOptions | undefined) => Promise;
down: (options?: IDockerComposeOptions | undefined) => Promise;
stop: (options?: IDockerComposeOptions | undefined) => Promise;
stopOne: (service: string, options?: IDockerComposeOptions | undefined) => Promise;
stopMany: (options?: IDockerComposeOptions | undefined, ...services: string[]) => Promise;
pauseOne: (service: string, options?: IDockerComposeOptions | undefined) => Promise;
unpauseOne: (service: string, options?: IDockerComposeOptions | undefined) => Promise;
kill: (options?: IDockerComposeOptions | undefined) => Promise;
rm: (options?: IDockerComposeOptions | undefined, ...services: string[]) => Promise;
exec: (container: string, command: string | string[], options?: IDockerComposeOptions | undefined) => Promise;
run: (container: string, command: string | string[], options?: IDockerComposeOptions | undefined) => Promise;
buildAll: (options?: IDockerComposeBuildOptions) => Promise;
buildMany: (services: string[], options?: IDockerComposeBuildOptions) => Promise;
buildOne: (service: string, options?: IDockerComposeBuildOptions | undefined) => Promise;
pullAll: (options?: IDockerComposeOptions) => Promise;
pullMany: (services: string[], options?: IDockerComposeOptions) => Promise;
pullOne: (service: string, options?: IDockerComposeOptions | undefined) => Promise;
config: (options?: IDockerComposeOptions | undefined) => Promise>;
configServices: (options?: IDockerComposeOptions | undefined) => Promise>;
configVolumes: (options?: IDockerComposeOptions | undefined) => Promise>;
ps: (options?: IDockerComposeOptions | undefined) => Promise>;
push: (options?: IDockerComposePushOptions) => Promise;
restartAll: (options?: IDockerComposeOptions | undefined) => Promise;
restartMany: (services: string[], options?: IDockerComposeOptions | undefined) => Promise;
restartOne: (service: string, options?: IDockerComposeOptions | undefined) => Promise;
logs: (services: string | string[], options?: IDockerComposeLogOptions) => Promise;
port: (service: string, containerPort: string | number, options?: IDockerComposeOptions | undefined) => Promise>;
version: (options?: IDockerComposeOptions | undefined) => Promise>;
};
export default _default;
export * as v2 from './v2';