Interface AccountStore<TSettings>

Used to store account data.

interface AccountStore<TSettings> {
    create: (() => Promise<string>);
    getSetting: (<TKey>(id: string, setting: TKey) => Promise<undefined | TypeObject<TSettings>[TKey]>);
    updateSetting: (<TKey>(id: string, setting: TKey, value: TypeObject<TSettings>[TKey]) => Promise<void>);
}

Type Parameters

Implemented by

Properties

create getSetting updateSetting

Properties

create

create: (() => Promise<string>)

Creates a new and empty account. Since this account will not yet have a login method, implementations should restrict what is possible with this account, and should potentially have something in place to clean these accounts up if they are unused.

getSetting

getSetting: (<TKey>(id: string, setting: TKey) => Promise<undefined | TypeObject<TSettings>[TKey]>)

Finds the setting of the account with the given identifier. Returns undefined if there is no matching account.

Type declaration

updateSetting

updateSetting: (<TKey>(id: string, setting: TKey, value: TypeObject<TSettings>[TKey]) => Promise<void>)

Updates the settings for the account with the given identifier to the new values.

Type declaration

    • <TKey>(id, setting, value): Promise<void>

    • Type Parameters

      • TKey extends string

      Parameters

      • id: string

        The account identifier.

      • setting: TKey

        The setting to update.

      • value: TypeObject<TSettings>[TKey]

        The new value for the setting.

      Returns Promise<void>

Settings

Member Visibility

On This Page

Properties