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

Methods

delete

delete(name: string, params?: VolumeDeleteParams): Promise<void>
Parameters
- name: string
  削除する Volume の名前
- Optionalparams: VolumeDeleteParams
  オプションパラメータ
Returns Promise<void>
Description
名前付き Volume を削除する。削除は不可逆で、現在使用中の App にも影響する
- Defined in src/volume.ts:109

ephemeral

ephemeral(params?: VolumeEphemeralParams): Promise<Volume>
Parameters
- params: VolumeEphemeralParams = {}
  オプションパラメータ
Returns Promise<Volume>
一時的な Volume インスタンス

Description
名前のない一時的な Volume を作成する。closeEphemeral() が呼ばれるかプロセスが終了するまで存続する
- Defined in src/volume.ts:85

fromName

fromName(name: string, params?: VolumeFromNameParams): Promise<Volume>
Parameters
- name: string
  Volume の名前
- Optionalparams: VolumeFromNameParams
  オプションパラメータ
Returns Promise<Volume>
Volume インスタンス

Description
名前で Volume を参照する
- Defined in src/volume.ts:56