Type Alias: ContainerState
ContainerState =
object
A container's state, as Docker reports it when the container is read (DockerContainer.state, updated by its start(), stop(), pause()… methods).
Properties
dead
dead:
boolean
true when the container is dead: Docker failed to remove it.
exitCode
exitCode:
number
The exit code of the container's last run, 0 when it has not exited.
finishedAt
finishedAt:
Time|null
When the container last exited; null when it never exited.
OOMKilled
OOMKilled:
boolean
true when the kernel's OOM killer killed one of its processes, for lack of memory.
paused
paused:
boolean
true while the container is paused.
pid
pid:
number
The host process ID of the container's main process, 0 when it is not running.
restarting
restarting:
boolean
true while Docker restarts the container after its exit.
running
running:
boolean
true while the container is running, paused included.
startedAt
startedAt:
Time|null
When the container was last started; null when it was never started.
status
status:
"created"|"running"|"paused"|"restarting"|"removing"|"exited"|"dead"
The container's status: 'created' (never started), 'running', 'paused', 'restarting', 'removing', 'exited' or 'dead' (could not be removed).