@dxos/app-toolkit - v0.16.0
    Preparing search index...

    Type Alias SettingsSync

    Control surface over the device-synced settings store, which projects every Settings contribution (plus the plugin set) into the settings space so they follow the identity across devices, with per-key device overrides.

    Absent without an identity. Until the settings space opens, unsynced is empty and the actions do nothing.

    type SettingsSync = {
        pinned: Atom.Atom<AppSettings.DeviceSettings>;
        unsynced: Atom.Atom<readonly string[]>;
        conflicts(prefix: string): readonly string[];
        pinKey(prefix: string, key: string): void;
        rejoinAccount(prefix: string, options?: { adopt?: Adopt }): void;
        takeLocal(prefix: string): void;
        unpinKey(prefix: string, key: string): void;
    }
    Index

    Properties

    pinned unsynced

    Methods

    conflicts pinKey rejoinAccount takeLocal unpinKey

    Properties

    pinned: Atom.Atom<AppSettings.DeviceSettings>

    Which settings this device keeps to itself, by prefix.

    unsynced: Atom.Atom<readonly string[]>

    Settings prefixes this device writes locally rather than sharing.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods