Class VolumeService

Service for managing Volumes.

Normally only ever accessed via the client as:

const modal = new ModalClient();
const volume = await modal.volumes.fromName("my-volume");

Index

Constructors

Methods

delete ephemeral fromName

Constructors

constructor

new VolumeService(client: ModalClient): VolumeService
Parameters
- client: ModalClient
Returns VolumeService
- Defined in src/volume.ts:35

Methods

delete

delete(name: string, params?: VolumeDeleteParams): Promise<void>
Delete a named Volume.

Warning: Deletion is irreversible and will affect any Apps currently using the Volume.
Parameters
- name: string
- Optionalparams: VolumeDeleteParams
Returns Promise<void>
- Defined in src/volume.ts:94

ephemeral

ephemeral(params?: VolumeEphemeralParams): Promise<Volume>
Create a nameless, temporary Volume. It persists until closeEphemeral() is called, or the process exits.
Parameters
- params: VolumeEphemeralParams = {}
Returns Promise<Volume>
- Defined in src/volume.ts:70

fromName

fromName(name: string, params?: VolumeFromNameParams): Promise<Volume>
Reference a Volume by its name.
Parameters
- name: string
- Optionalparams: VolumeFromNameParams
Returns Promise<Volume>
- Defined in src/volume.ts:42