Interface SecretStorage

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

Hierarchy

SecretStorage

Index

Methods

Properties

onDidChange

Methods

get

get(key: string): Thenable<undefined | string>

- Defined in vscode.d.ts:6273
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.

store

store(key: string, value: string): Thenable<void>

- Defined in vscode.d.ts:6280
Store a secret under a given key.

Parameters
- key: string
  
  The key to store the secret under.
- value: string
  
  The secret.
Returns Thenable<void>

delete

delete(key: string): Thenable<void>

- Defined in vscode.d.ts:6286
Remove a secret from storage.

Parameters
- key: string
  
  The key the secret was stored under.
Returns Thenable<void>

Properties

onDidChange

onDidChange: Event<SecretStorageChangeEvent>

Fires when a secret is stored or deleted.

Generated using TypeDoc