Interface CredentialWallet

Public shape provided by CredentialWalletMixin.

interface CredentialWallet {
    ensureCredential<K extends CredentialKind>(kind: K): CredentialByKind[K];
    getCredential<K extends CredentialKind>(
        kind: K,
    ): CredentialByKind[K] | undefined;
    getCredentials(): readonly Credential[];
    hasCredential(kind: CredentialKind): boolean;
}

Index

Methods

ensureCredential getCredential getCredentials hasCredential

Methods

ensureCredential

ensureCredential<K extends CredentialKind>(kind: K): CredentialByKind[K]
The held credential of kind, minting a default one if absent.
Type Parameters
- K extends CredentialKind
Parameters
- kind: K
Returns CredentialByKind[K]
- Defined in packages/server/src/mud/lib/credential/CredentialWallet.ts:48

getCredential

getCredential<K extends CredentialKind>(
kind: K,
): CredentialByKind[K] | undefined
The held credential of kind, or undefined if the wallet has none.
Type Parameters
- K extends CredentialKind
Parameters
- kind: K
Returns CredentialByKind[K] | undefined
- Defined in packages/server/src/mud/lib/credential/CredentialWallet.ts:44

getCredentials

getCredentials(): readonly Credential[]
A snapshot of every held credential.

Returns readonly Credential[]
- Defined in packages/server/src/mud/lib/credential/CredentialWallet.ts:52

hasCredential

hasCredential(kind: CredentialKind): boolean
Whether the wallet currently holds a credential of kind.
Parameters
- kind: CredentialKind
Returns boolean
- Defined in packages/server/src/mud/lib/credential/CredentialWallet.ts:50