Interface CredentialStore

Somewhere secrets are kept: the OS credential store, VS Code SecretStorage, or memory.

interface CredentialStore {
    name: string;
    delete(ref: SecretRef): Promise<boolean>;
    get(ref: SecretRef): Promise<string | undefined>;
    set(ref: SecretRef, secret: string): Promise<void>;
}

Hierarchy (View Summary)

SecretSource
- CredentialStore

Implemented by

MemoryCredentialStore

Index

Properties

Methods

Properties

`Readonly`name

name: string

A name for messages, such as "Windows Credential Manager".

Methods

delete

delete(ref: SecretRef): Promise<boolean>
Resolves true when a secret was deleted, false when there was none.
Parameters
- ref: SecretRef
Returns Promise<boolean>
- Defined in credentials/types.ts:35

get

get(ref: SecretRef): Promise<string | undefined>
The secret for ref, or undefined when this source has none.
Parameters
- ref: SecretRef
Returns Promise<string | undefined>
Inherited from SecretSource.get
- Defined in credentials/types.ts:25

set

set(ref: SecretRef, secret: string): Promise<void>
Keeps secret for ref, replacing any secret kept before.
Parameters
- ref: SecretRef
- secret: string
Returns Promise<void>
- Defined in credentials/types.ts:33