@augment-vir/node
Version:
A collection of augments, helpers types, functions, and classes only for Node.js (backend) JavaScript environments.
33 lines (32 loc) • 1.52 kB
TypeScript
export declare function getContainerLogs(containerNameOrId: string, latestLineCount?: number): Promise<string>;
/**
* All possible statuses for an existing container.
*
* @category Node : Docker : Util
* @category Package : @augment-vir/node
* @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
*/
export declare enum DockerContainerStatus {
Created = "created",
Running = "running",
Paused = "paused",
Restarting = "restarting",
Exited = "exited",
Removing = "removing",
Dead = "dead",
/** This is not a native Docker status but indicates that the container does not exist. */
Removed = "removed"
}
/**
* Statuses from {@link DockerContainerStatus} that indicate that a container has been exited in some
* way.
*
* @category Node : Docker : Util
* @category Package : @augment-vir/node
* @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
*/
export declare const exitedDockerContainerStatuses: DockerContainerStatus[];
export declare function getContainerStatus(containerNameOrId: string): Promise<DockerContainerStatus>;
export declare function waitUntilContainerRunning(containerNameOrId: string, failureMessage?: string | undefined): Promise<void>;
export declare function waitUntilContainerRemoved(containerNameOrId: string, failureMessage?: string | undefined): Promise<void>;
export declare function waitUntilContainerExited(containerNameOrId: string, failureMessage?: string | undefined): Promise<void>;