@apiclient.xyz/docker
Version:
Provides easy communication with Docker remote API from Node.js, with TypeScript support.
49 lines (48 loc) • 1.48 kB
TypeScript
import * as interfaces from './interfaces/index.js';
import { DockerHost } from './classes.host.js';
export declare class DockerService {
static getServices(dockerHost: DockerHost): Promise<DockerService[]>;
static getServiceByName(dockerHost: DockerHost, networkName: string): Promise<DockerService>;
/**
* creates a service
*/
static createService(dockerHost: DockerHost, serviceCreationDescriptor: interfaces.IServiceCreationDescriptor): Promise<DockerService>;
dockerHostRef: DockerHost;
ID: string;
Version: {
Index: number;
};
CreatedAt: string;
UpdatedAt: string;
Spec: {
Name: string;
Labels: interfaces.TLabels;
TaskTemplate: {
ContainerSpec: {
Image: string;
Isolation: string;
Secrets: Array<{
File: {
Name: string;
UID: string;
GID: string;
Mode: number;
};
SecretID: string;
SecretName: string;
}>;
};
ForceUpdate: 0;
};
Mode: {};
Networks: [any[]];
};
Endpoint: {
Spec: {};
VirtualIPs: [any[]];
};
constructor(dockerHostArg: DockerHost);
remove(): Promise<void>;
reReadFromDockerEngine(): Promise<void>;
needsUpdate(): Promise<boolean>;
}