Files
docker/ts/interfaces/container.ts

51 lines
1.4 KiB
TypeScript
Raw Normal View History

import { DockerNetwork } from '../classes.network.js';
2019-08-14 14:19:45 +02:00
/**
* Container creation descriptor supporting both string references and class instances.
* Strings will be resolved to resources internally.
*/
2019-08-14 23:21:54 +02:00
export interface IContainerCreationDescriptor {
2019-08-15 18:50:13 +02:00
Hostname: string;
Domainname: string;
/** Network names (strings) or DockerNetwork instances */
networks?: (string | DockerNetwork)[];
2019-08-14 14:19:45 +02:00
}
/**
* Information about an exec instance, including exit code and running state.
* Retrieved via container.exec().inspect()
*/
export interface IExecInspectInfo {
/** Exit code of the exec command (0 = success) */
ExitCode: number;
/** Whether the exec is currently running */
Running: boolean;
/** Process ID */
Pid: number;
/** Container ID where exec runs */
ContainerID: string;
/** Exec instance ID */
ID: string;
/** Whether stderr is open */
OpenStderr: boolean;
/** Whether stdin is open */
OpenStdin: boolean;
/** Whether stdout is open */
OpenStdout: boolean;
/** Whether exec can be removed */
CanRemove: boolean;
/** Detach keys */
DetachKeys: string;
/** Process configuration */
ProcessConfig: {
/** Whether TTY is allocated */
tty: boolean;
/** Entrypoint */
entrypoint: string;
/** Command arguments */
arguments: string[];
/** Whether running in privileged mode */
privileged: boolean;
};
}