@aicacia/db
    Preparing search index...

    Interface ISingleton<T>

    Singleton interface

    interface ISingleton<T> {
        id: string;
        getStatus(): AdapterStatus;
        set(doc: T): Promise<void>;
        subscribe(
            onUpdate: (value: T | undefined) => void,
            onError?: (error: Error) => void,
        ): UnsubscribeFn;
        update(changes: Partial<T>): Promise<void>;
    }

    Type Parameters

    • T

    Implemented by

    Index

    Properties

    Methods

    Properties

    id: string

    Methods

    • Replace entire singleton value

      Parameters

      • doc: T

      Returns Promise<void>

      Error if set fails

    • Subscribe to singleton value

      Parameters

      • onUpdate: (value: T | undefined) => void
      • OptionalonError: (error: Error) => void

      Returns UnsubscribeFn

    • Merge changes into singleton value

      Parameters

      • changes: Partial<T>

      Returns Promise<void>

      Error if update fails