@aicacia/db
    Preparing search index...

    Interface ICollection<T>

    interface ICollection<T> {
        id: string;
        create(doc: T): Promise<void>;
        delete(id: string): Promise<void>;
        getKeyField(): | (
            T extends object
                ? | Extract<keyof T, string>
                | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
                    ?
                        | Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>
                        | `${Extract<keyof NonNullable<(...)[(...)]>, string>}.${NonNullable<
                            NonNullable<(...)>[Extract<(...), (...)>],
                        > extends object
                            ?
                                | Extract<keyof (...), string>
                                | `${Extract<(...), (...)>}.${Extract<(...), (...)>}`
                            : never}`
                    : never}`
                : never
        )
        | undefined;
        getKeyOf(): (doc: T) => string;
        getStatus(): AdapterStatus;
        query(): IQueryBuilder<T>;
        subscribe(
            onUpdate: (docs: T[]) => void,
            onError?: (error: Error) => void,
        ): UnsubscribeFn;
        update(id: string, changes: Partial<T>): Promise<void>;
    }

    Type Parameters

    • T

    Implemented by

    Index

    Properties

    id

    Methods

    create delete getKeyField getKeyOf getStatus query subscribe update

    Properties

    id: string

    Methods

    • Returns
          | (
              T extends object
                  ? | Extract<keyof T, string>
                  | `${Extract<keyof T, string>}.${NonNullable<T[Extract<keyof T, string>]> extends object
                      ?
                          | Extract<keyof NonNullable<T[Extract<(...), (...)>]>, string>
                          | `${Extract<keyof NonNullable<(...)[(...)]>, string>}.${NonNullable<
                              NonNullable<(...)>[Extract<(...), (...)>],
                          > extends object
                              ?
                                  | Extract<keyof (...), string>
                                  | `${Extract<(...), (...)>}.${Extract<(...), (...)>}`
                              : never}`
                      : never}`
                  : never
          )
          | undefined

    • Parameters

      • id: string
      • changes: Partial<T>

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods