Class Image

A container image, used for starting Sandboxes.

Index

Accessors

Methods

build dockerfileCommands publish

Accessors

imageId

get imageId(): string
Returns string
- Defined in src/image.ts:277

Methods

build

build(app: App): Promise<Image>
Eagerly builds an Image on Modal.
Parameters
- app: App
  App to use to build the Image.
Returns Promise<Image>
- Defined in src/image.ts:338

dockerfileCommands

dockerfileCommands(
commands: string[],
params?: ImageDockerfileCommandsParams,
): Image
Extend an image with arbitrary Dockerfile-like commands.

Each call creates a new Image layer that will be built sequentially. The provided options apply only to this layer.
Parameters
- commands: string[]
  Array of Dockerfile commands as strings
- Optionalparams: ImageDockerfileCommandsParams
  Optional configuration for this layer's build
Returns Image
A new Image instance
- Defined in src/image.ts:302

publish

publish(name: string, params?: ImagePublishParams): Promise<void>
Publish this built Image under a stable name and tag.
Parameters
- name: string
  Name to publish the Image under, optionally including a tag as name:tag. If no tag is included, :latest is used.
- params: ImagePublishParams = {}
  Optional environment.
Returns Promise<void>
- Defined in src/image.ts:461