Installation
npm install --save @types/dockerode-compose
Summary
This package contains type definitions for dockerode-compose (https://github.com/apocas/dockerode-compose#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/dockerode-compose.
index.d.ts
import * as Dockerode from "dockerode";
declare namespace DockerodeCompose {
interface ComposeDownOptions {
volumes: boolean;
}
interface ComposeDownOutput {
file: string;
services: [];
networks: [];
volumes: [] | undefined;
}
interface ComposeUpOptions {
verbose: boolean;
}
interface ComposeUpOutput {
file: string;
secrets: any[];
volumes: Dockerode.VolumeCreateResponse[];
configs: any[];
networks: Network[];
services: Dockerode.Container[];
}
interface ComposePullOptions {
verbose: boolean;
streams: boolean;
}
interface Network {
name: string;
network: Dockerode.Network;
}
}
declare class Compose {
constructor(dockerode: Dockerode, file: string, projectName: string);
/* @async */
down(options?: DockerodeCompose.ComposeDownOptions): Promise<DockerodeCompose.ComposeDownOutput>;
/* @async */
up(options?: DockerodeCompose.ComposeUpOptions): Promise<DockerodeCompose.ComposeUpOutput>;
/* @async */
pull(serviceN?: string, options?: DockerodeCompose.ComposePullOptions): Promise<any[]>;
}
export = Compose;
Additional Details
- Last updated: Wed, 21 Feb 2024 08:08:29 GMT
- Dependencies: @types/dockerode
Credits
These definitions were written by Josua Frank.