Class DockerImageBuilder

Conveniently build a Docker image.

Hierarchy

DockerImageBuilder

Index

Constructors

constructor

Properties

dockerode

Methods

Constructors

constructor

new DockerImageBuilder(dockerode: Dockerode): DockerImageBuilder

- Defined in packages/jbr/lib/docker/DockerImageBuilder.ts:11
Parameters
- dockerode: Dockerode
Returns DockerImageBuilder

Properties

Private Readonly dockerode

dockerode: Dockerode

Methods

build

build(options: IDockerImageBuilderArgs): Promise<void>

- Defined in packages/jbr/lib/docker/DockerImageBuilder.ts:19
Build an image

Parameters
- options: IDockerImageBuilderArgs
  
  Image options
Returns Promise<void>

getImageName

getImageName(context: ITaskContext, suffix: string): string

- Defined in packages/jbr/lib/docker/DockerImageBuilder.ts:50
Obtain a proper image name within the current jbr experiment context with the given suffix.

Parameters
- context: ITaskContext
  
  A task context.
- suffix: string
  
  A suffix to add to the image name.
Returns string

Generated using TypeDoc