Sporades SDK API
    Preparing search index...

    Type Alias PreferencesApi<Preferences>

    Current-user preferences API.

    Preferences are runtime-owned JSON keyed by the Sporades user identity. They are not part of Capsule app schema and do not appear on ctx.db.

    type PreferencesApi<Preferences extends JsonObject = JsonObject> = {
        get(): Promise<SporadesResult<PreferencesResult<Preferences>>>;
        update<Patch extends Partial<Preferences> & JsonObject>(
            patch: Patch,
        ): Promise<SporadesResult<PreferencesResult<Preferences & Patch>>>;
    }

    Type Parameters

    Index
    get update

    Settings
    Member Visibility

    On This Page
    Methods