Class DockerContainerCreator

Conveniently create a Docker container.

Hierarchy

DockerContainerCreator

Index

Constructors

constructor

Properties

dockerode

Methods

remove
start

Constructors

constructor

new DockerContainerCreator(dockerode: Dockerode): DockerContainerCreator

- Defined in packages/jbr/lib/docker/DockerContainerCreator.ts:12
Parameters
- dockerode: Dockerode
Returns DockerContainerCreator

Properties

Private Readonly dockerode

dockerode: Dockerode

Methods

remove

remove(name: string): Promise<void>

- Defined in packages/jbr/lib/docker/DockerContainerCreator.ts:64
Remove a container

Parameters
- name: string
  
  A container name
Returns Promise<void>

start

start(options: IDockerContainerCreatorArgs): Promise<DockerContainerHandler>

- Defined in packages/jbr/lib/docker/DockerContainerCreator.ts:20
Start a container.

Parameters
- options: IDockerContainerCreatorArgs
  
  Container options
Returns Promise<DockerContainerHandler>

Generated using TypeDoc