Class SecretService

Service for managing Secrets.

Normally only ever accessed via the client as:

const modal = new ModalClient();
const secret = await modal.secrets.fromName("my-secret");

Index

Constructors

Methods

delete fromName fromObject

Constructors

constructor

new SecretService(client: ModalClient): SecretService
Parameters
- client: ModalClient
Returns SecretService
- Defined in src/secret.ts:45

Methods

delete

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

fromName

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

Description
名前で Secret を参照する
- Defined in src/secret.ts:55

fromObject

fromObject(
entries: Record<string, string>,
params?: SecretFromObjectParams,
): Promise<Secret>
Parameters
- entries: Record<string, string>
  文字列のキーと値のオブジェクト
- Optionalparams: SecretFromObjectParams
  オプションパラメータ
Returns Promise<Secret>
Secret インスタンス

Description
キーと値のペアから Secret を作成する
- Defined in src/secret.ts:89