Interface KeyringEntry

The part of a @napi-rs/keyring entry this store uses.

interface KeyringEntry {
    deleteCredential(): Promise<boolean>;
    getPassword(): Promise<string | null>;
    setPassword(password: string): Promise<void>;
}

Index

Methods

deleteCredential getPassword setPassword

Methods

deleteCredential

deleteCredential(): Promise<boolean>
Deletes the stored secret; true when there was one.

Returns Promise<boolean>
- Defined in credentials/keyring.ts:11

getPassword

getPassword(): Promise<string | null>
The stored secret, or null when there is none.

Returns Promise<string | null>
- Defined in credentials/keyring.ts:7

setPassword

setPassword(password: string): Promise<void>
Stores a secret, replacing any stored before.
Parameters
- password: string
Returns Promise<void>
- Defined in credentials/keyring.ts:9