@augment-vir/node
Version:
A collection of augments, helpers types, functions, and classes only for Node.js (backend) JavaScript environments.
24 lines (23 loc) • 1.02 kB
TypeScript
import { type DockerEnvMap, type DockerPortMap, type DockerVolumeMap } from './docker-command-inputs.js';
/**
* Parameters for `docker.container.run`.
*
* @category Node : Docker : Util
* @category Package : @augment-vir/node
* @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
*/
export type RunDockerContainerParams = {
imageName: string;
detach: boolean;
command?: string;
containerName: string;
volumeMapping?: ReadonlyArray<DockerVolumeMap> | undefined;
portMapping?: ReadonlyArray<DockerPortMap> | undefined;
envMapping?: DockerEnvMap | undefined;
executionEnv?: Record<string, string>;
removeWhenDone?: boolean;
dockerFlags?: ReadonlyArray<string>;
useCurrentUser?: boolean;
platform?: string;
};
export declare function runContainer({ containerName, imageName, detach, command, portMapping, volumeMapping, envMapping, executionEnv, removeWhenDone, useCurrentUser, dockerFlags, platform, }: RunDockerContainerParams): Promise<void>;