@types/dockerode-compose
TypeScript icon, indicating that this package has built-in type declarations

1.4.1 • Public • Published

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

Credits

These definitions were written by Josua Frank.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/dockerode-compose

Weekly Downloads

84

Version

1.4.1

License

MIT

Unpacked Size

5.17 kB

Total Files

5

Last publish

Collaborators

  • types