Class Collection<T>

constructor

• new Collection<T>(config: CollectionConfig<T>): Collection<T>

  Type Parameters

  • T

  Parameters

  • config: CollectionConfig<T>

  Returns Collection<T>

Readonlyid

create

• create(doc: T): Promise<void>

  Parameters

  • doc: T

  Returns Promise<void>

delete

• delete(id: string): Promise<void>

  Parameters

  • id: string

  Returns Promise<void>

getKeyField

• 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

  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

getKeyOf

• getKeyOf(): (doc: T) => string

  Returns (doc: T) => string

getStatus

• getStatus(): AdapterStatus

  Returns AdapterStatus

query

• query(): IQueryBuilder<T>

  Returns IQueryBuilder<T>

subscribe

• subscribe(
      onUpdate: (docs: T[]) => void,
      onError?: (error: Error) => void,
  ): UnsubscribeFn

  Parameters

  • onUpdate: (docs: T[]) => void
  • OptionalonError: (error: Error) => void

  Returns UnsubscribeFn

update

• update(id: string, changes: Partial<T>): Promise<void>

  Parameters

  • id: string
  • changes: Partial<T>

  Returns Promise<void>