UNPKG

@apiclient.xyz/docker

Version:

Provides easy communication with Docker remote API from Node.js, with TypeScript support.

51 lines (50 loc) 1.5 kB
import * as interfaces from './interfaces/index.js'; import { DockerHost } from './classes.host.js'; export declare class DockerContainer { /** * get all containers */ static getContainers(dockerHostArg: DockerHost): Promise<DockerContainer[]>; /** * gets an container by Id * @param containerId */ static getContainerById(containerId: string): Promise<void>; /** * create a container */ static create(dockerHost: DockerHost, containerCreationDescriptor: interfaces.IContainerCreationDescriptor): Promise<void>; dockerHost: DockerHost; Id: string; Names: string[]; Image: string; ImageID: string; Command: string; Created: number; Ports: interfaces.TPorts; Labels: interfaces.TLabels; State: string; Status: string; HostConfig: any; NetworkSettings: { Networks: { [key: string]: { IPAMConfig: any; Links: any; Aliases: any; NetworkID: string; EndpointID: string; Gateway: string; IPAddress: string; IPPrefixLen: number; IPv6Gateway: string; GlobalIPv6Address: string; GlobalIPv6PrefixLen: number; MacAddress: string; DriverOpts: any; }; }; }; Mounts: any; constructor(dockerHostArg: DockerHost, dockerContainerObjectArg: any); }