docker-companion/dist/docker.container.d.ts

A package for managing lifecycle and execution of docker containers.

/// <reference types="node" />
import { PathLike } from "fs";
import { ExecutionResult } from "./docker";
export declare type BuildArgs = {
    volumes?: Array<[source: PathLike, target: PathLike]>;
    ports?: Array<[source: number, target: number]>;
    entryPoint?: string;
    runOpts?: string[];
    image: string;
};
export declare const build: (args: BuildArgs) => RunnableContainer;
export declare class RunnableContainer {
    private readonly args;
    constructor(args: BuildArgs);
    start(): Promise<DockerContainer>;
    private extractRunOpts;
}
export declare class DockerContainer {
    readonly id: string;
    constructor(id: string);
    execute(command: Array<string>): Promise<ExecutionResult>;
    stop(): Promise<void>;
}