View source

typedef SecretStorage

package vscode

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

Fields

store(key:String, value:String):Thenable<Void>

Store a secret under a given key.

Parameters:

key

The key to store the secret under.

value

The secret.

onDidChange:Event<SecretStorageChangeEvent>

Fires when a secret is stored or deleted.

get(key:String):Thenable<Null<String>>

Retrieve a secret that was stored with key. Returns undefined if there is no password matching that key.

Parameters:

key

The key the secret was stored under.

Returns:

The stored value or undefined.

delete(key:String):Thenable<Void>

Remove a secret from storage.

Parameters:

key

The key the secret was stored under.