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

Methods

delete

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

Warning: Deletion is irreversible and will affect any Apps currently using the Secret.
Parameters
- name: string
- Optionalparams: SecretDeleteParams
Returns Promise<void>
- Defined in src/secret.ts:109

fromName

fromName(name: string, params?: SecretFromNameParams): Promise<Secret>
Reference a Secret by its name.
Parameters
- name: string
- Optionalparams: SecretFromNameParams
Returns Promise<Secret>
- Defined in src/secret.ts:39

fromObject

fromObject(
entries: Record<string, string>,
params?: SecretFromObjectParams,
): Promise<Secret>
Create a Secret from a plain object of key-value pairs.
Parameters
- entries: Record<string, string>
- Optionalparams: SecretFromObjectParams
Returns Promise<Secret>
- Defined in src/secret.ts:68