Interface SecretStorage

Represents a storage utility for secrets, information that is sensitive.

interface SecretStorage {
    onDidChange: Event<SecretStorageChangeEvent>;
    delete(key): Thenable<void>;
    get(key): Thenable<undefined | string>;
    store(key, value): Thenable<void>;
}

Implemented by

SecretStorageExt

Index

Properties

Methods

delete get store

Properties

onDidChange

onDidChange: Event<SecretStorageChangeEvent>

Fires when a secret is stored or deleted.

Methods

delete

delete(key): Thenable<void>
Remove a secret from storage.
Parameters
- key: string
  The key the secret was stored under.
Returns Thenable<void>
- Defined in packages/plugin/src/theia.d.ts:4477

get

get(key): Thenable<undefined | string>
Retrieve a secret that was stored with key. Returns undefined if there is no password matching that key.
Parameters
- key: string
  The key the secret was stored under.
Returns Thenable<undefined | string>
The stored value or undefined.
- Defined in packages/plugin/src/theia.d.ts:4464

store

store(key, value): Thenable<void>
Store a secret under a given key.
Parameters
- key: string
  The key to store the secret under.
- value: string
  The secret.
Returns Thenable<void>
- Defined in packages/plugin/src/theia.d.ts:4471