Class SecretStorageExt

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

Implements

SecretStorage

Index

Constructors

Properties

id onDidChange onDidChangeEmitter secretState

Methods

delete get store

Constructors

constructor

new SecretStorageExt(pluginDescription, secretState): SecretStorageExt
Parameters
- pluginDescription: Plugin
- secretState: InternalSecretsExt
Returns SecretStorageExt
- Defined in packages/plugin-ext/src/plugin/secrets-ext.ts:82

Properties

`Protected` `Readonly` id

id: string

`Readonly` onDidChange

onDidChange: Event<SecretStorageChangeEvent> = ...

Fires when a secret is stored or deleted.

`Private` onDidChangeEmitter

onDidChangeEmitter: Emitter<SecretStorageChangeEvent> = ...

`Readonly` secretState

secretState: InternalSecretsExt

Methods

delete

delete(key): Promise<void>
Remove a secret from storage.
Parameters
- key: string
  The key the secret was stored under.
Returns Promise<void>
Implementation of SecretStorage.delete
- Defined in packages/plugin-ext/src/plugin/secrets-ext.ts:101

get

get(key): Promise<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 Promise<undefined | string>
The stored value or undefined.
Implementation of SecretStorage.get
- Defined in packages/plugin-ext/src/plugin/secrets-ext.ts:93

store

store(key, value): Promise<void>
Store a secret under a given key.
Parameters
- key: string
  The key to store the secret under.
- value: string
  The secret.
Returns Promise<void>
Implementation of SecretStorage.store
- Defined in packages/plugin-ext/src/plugin/secrets-ext.ts:97