docker: { container: { copyTo: ( __namedParameters: CopyToDockerContainerParams, ) => Promise<void>; getInfo: ( containerNameOrId: string, ) => Promise<DockerContainerInfo | undefined>; getLogs: ( containerNameOrId: string, latestLineCount?: number, ) => Promise<string>; getStatus: (containerNameOrId: string) => Promise<DockerContainerStatus>; kill: ( containerNameOrId: string, options?: PartialWithUndefined<{ keepContainer: boolean }>, ) => Promise<void>; run: (__namedParameters: RunDockerContainerParams) => Promise<void>; runCommand: ( __namedParameters: RunDockerContainerCommandParams, ) => Promise<ShellOutput>; tryOrKill: <T>( containerNameOrId: string, callback: (containerNameOrId: string) => MaybePromise<T>, ) => Promise<Awaited<T>>; waitUntilExited: ( containerNameOrId: string, failureMessage?: string, ) => Promise<void>; waitUntilRemoved: ( containerNameOrId: string, failureMessage?: string, ) => Promise<void>; waitUntilRunning: ( containerNameOrId: string, failureMessage?: string, ) => Promise<void>; }; image: { exists: (imageName: string) => Promise<boolean>; remove: (imageName: string) => Promise<void>; update: (imageName: string, platform?: string) => Promise<void>; }; isRunning: () => Promise<boolean>; start: () => Promise<void>; util: { makeEnvFlags: ( envMapping?: Readonly< Record<string, { allowInterpolation: boolean; value: string }>, >, ) => string; makePortMapFlags: (portMapping?: readonly DockerPortMap[]) => string; makeVolumeFlags: (volumeMapping?: readonly DockerVolumeMap[]) => string; };} = ... Type declaration
container: {
copyTo: (
__namedParameters: CopyToDockerContainerParams,
) => Promise<void>;
getInfo: (
containerNameOrId: string,
) => Promise<DockerContainerInfo | undefined>;
getLogs: (
containerNameOrId: string,
latestLineCount?: number,
) => Promise<string>;
getStatus: (containerNameOrId: string) => Promise<DockerContainerStatus>;
kill: (
containerNameOrId: string,
options?: PartialWithUndefined<{ keepContainer: boolean }>,
) => Promise<void>;
run: (__namedParameters: RunDockerContainerParams) => Promise<void>;
runCommand: (
__namedParameters: RunDockerContainerCommandParams,
) => Promise<ShellOutput>;
tryOrKill: <T>(
containerNameOrId: string,
callback: (containerNameOrId: string) => MaybePromise<T>,
) => Promise<Awaited<T>>;
waitUntilExited: (
containerNameOrId: string,
failureMessage?: string,
) => Promise<void>;
waitUntilRemoved: (
containerNameOrId: string,
failureMessage?: string,
) => Promise<void>;
waitUntilRunning: (
containerNameOrId: string,
failureMessage?: string,
) => Promise<void>;
}
getInfo: (containerNameOrId: string) => Promise<DockerContainerInfo | undefined>
getLogs: (containerNameOrId: string, latestLineCount?: number) => Promise<string>
getStatus: (containerNameOrId: string) => Promise<DockerContainerStatus>
kill: (
containerNameOrId: string,
options?: PartialWithUndefined<{ keepContainer: boolean }>,
) => Promise<void>
tryOrKill: <T>(
containerNameOrId: string,
callback: (containerNameOrId: string) => MaybePromise<T>,
) => Promise<Awaited<T>>
waitUntilExited: (containerNameOrId: string, failureMessage?: string) => Promise<void>
waitUntilRemoved: (containerNameOrId: string, failureMessage?: string) => Promise<void>
waitUntilRunning: (containerNameOrId: string, failureMessage?: string) => Promise<void>
image: {
exists: (imageName: string) => Promise<boolean>;
remove: (imageName: string) => Promise<void>;
update: (imageName: string, platform?: string) => Promise<void>;
}
exists: (imageName: string) => Promise<boolean>
remove: (imageName: string) => Promise<void>
update: (imageName: string, platform?: string) => Promise<void>
isRunning: () => Promise<boolean>
start: () => Promise<void>
util: {
makeEnvFlags: (
envMapping?: Readonly<
Record<string, { allowInterpolation: boolean; value: string }>,
>,
) => string;
makePortMapFlags: (portMapping?: readonly DockerPortMap[]) => string;
makeVolumeFlags: (volumeMapping?: readonly DockerVolumeMap[]) => string;
}
makeEnvFlags: (
envMapping?: Readonly<
Record<string, { allowInterpolation: boolean; value: string }>,
>,
) => string
makePortMapFlags: (portMapping?: readonly DockerPortMap[]) => string
makeVolumeFlags: (volumeMapping?: readonly DockerVolumeMap[]) => string
Centralized Docker API from
@augment-vir/node
.