Class Image

A container image, used for starting Sandboxes.

Index

Accessors

Methods

build dockerfileCommands delete fromAwsEcr fromGcpArtifactRegistry fromId fromRegistry

Accessors

imageId

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

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:267

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:238

`Static`delete

delete(imageId: string, _?: ImageDeleteParams): Promise<void>
Parameters
- imageId: string
- _: ImageDeleteParams = {}
Returns Promise<void>
Deprecated
Use client.images.delete() instead.
- Defined in src/image.ts:374

`Static`fromAwsEcr

fromAwsEcr(tag: string, secret: Secret): Image
Parameters
- tag: string
- secret: Secret
Returns Image
Deprecated
Use client.images.fromAwsEcr() instead.
- Defined in src/image.ts:206

`Static`fromGcpArtifactRegistry

fromGcpArtifactRegistry(tag: string, secret: Secret): Image
Parameters
- tag: string
- secret: Secret
Returns Image
Deprecated
Use client.images.fromGcpArtifactRegistry() instead.
- Defined in src/image.ts:213

`Static`fromId

fromId(imageId: string): Promise<Image>
Parameters
- imageId: string
Returns Promise<Image>
Deprecated
Use client.images.fromId() instead.
- Defined in src/image.ts:192

`Static`fromRegistry

fromRegistry(tag: string, secret?: Secret): Image
Parameters
- tag: string
- Optionalsecret: Secret
Returns Image
Deprecated
Use client.images.fromRegistry() instead.
- Defined in src/image.ts:199