Class ImageService

Service for managing Images.

Normally only ever accessed via the client as:

const modal = new ModalClient();
const image = await modal.images.fromRegistry("alpine");

Index

Constructors

Methods

delete fromAwsEcr fromGcpArtifactRegistry fromId fromRegistry

Constructors

constructor

new ImageService(client: ModalClient): ImageService
Parameters
- client: ModalClient
Returns ImageService
- Defined in src/image.ts:27

Methods

delete

delete(imageId: string, _?: ImageDeleteParams): Promise<void>
Delete an Image by ID. Warning: This removes an entire Image, and cannot be undone.
Parameters
- imageId: string
- _: ImageDeleteParams = {}
Returns Promise<void>
- Defined in src/image.ts:122

fromAwsEcr

fromAwsEcr(tag: string, secret: Secret): Image
Creates an Image from a raw registry tag, optionally using a Secret for authentication.
Parameters
- tag: string
  The registry tag for the Image.
- secret: Secret
  A Secret containing credentials for registry authentication.
Returns Image
- Defined in src/image.ts:81

fromGcpArtifactRegistry

fromGcpArtifactRegistry(tag: string, secret: Secret): Image
Creates an Image from a raw registry tag, optionally using a Secret for authentication.
Parameters
- tag: string
  The registry tag for the Image.
- secret: Secret
  A Secret containing credentials for registry authentication.
Returns Image
- Defined in src/image.ts:103

fromId

fromId(imageId: string): Promise<Image>
Creates an Image from an Image ID
Parameters
- imageId: string
  Image ID.
Returns Promise<Image>
- Defined in src/image.ts:36

fromRegistry

fromRegistry(tag: string, secret?: Secret): Image
Creates an Image from a raw registry tag, optionally using a Secret for authentication.
Parameters
- tag: string
  The registry tag for the Image.
- Optionalsecret: Secret
  Optional. A Secret containing credentials for registry authentication.
Returns Image
- Defined in src/image.ts:59