Interface Collection<T, Key>

db

and

• and(filter: (x: T) => boolean): Collection<T, Key, T>

  Parameters

  • filter: (x: T) => boolean

  Returns Collection<T, Key, T>

clone

• clone(props?: Object): Collection<T, Key, T>

  Parameters

  • Optionalprops: Object

  Returns Collection<T, Key, T>

count

• count(): PromiseExtended<number>

  Returns PromiseExtended<number>

• count<R>(thenShortcut: ThenShortcut<number, R>): PromiseExtended<R>

  Type Parameters

  • R

  Parameters

  • thenShortcut: ThenShortcut<number, R>

  Returns PromiseExtended<R>

delete

• delete(): PromiseExtended<number>

  Returns PromiseExtended<number>

distinct

• distinct(): Collection<T, Key, T>

  Returns Collection<T, Key, T>

each

• each(
      callback: (
          obj: T,
          cursor: { key: IndexableType; primaryKey: Key },
      ) => any,
  ): PromiseExtended<void>

  Parameters

  • callback: (obj: T, cursor: { key: IndexableType; primaryKey: Key }) => any

  Returns PromiseExtended<void>

eachKey

• eachKey(
      callback: (
          key: IndexableType,
          cursor: { key: IndexableType; primaryKey: Key },
      ) => any,
  ): PromiseExtended<void>

  Parameters

  • callback: (key: IndexableType, cursor: { key: IndexableType; primaryKey: Key }) => any

  Returns PromiseExtended<void>

eachPrimaryKey

• eachPrimaryKey(
      callback: (
          key: Key,
          cursor: { key: IndexableType; primaryKey: Key },
      ) => any,
  ): PromiseExtended<void>

  Parameters

  • callback: (key: Key, cursor: { key: IndexableType; primaryKey: Key }) => any

  Returns PromiseExtended<void>

eachUniqueKey

• eachUniqueKey(
      callback: (
          key: IndexableType,
          cursor: { key: IndexableType; primaryKey: Key },
      ) => any,
  ): PromiseExtended<void>

  Parameters

  • callback: (key: IndexableType, cursor: { key: IndexableType; primaryKey: Key }) => any

  Returns PromiseExtended<void>

filter

• filter<S>(filter: (x: T) => x is S): Collection<S, Key>

  Type Parameters

  • S

  Parameters

  • filter: (x: T) => x is S

  Returns Collection<S, Key>

• filter(filter: (x: T) => boolean): Collection<T, Key, T>

  Parameters

  • filter: (x: T) => boolean

  Returns Collection<T, Key, T>

first

• first(): PromiseExtended<T | undefined>

  Returns PromiseExtended<T | undefined>

• first<R>(thenShortcut: ThenShortcut<T | undefined, R>): PromiseExtended<R>

  Type Parameters

  • R

  Parameters

  • thenShortcut: ThenShortcut<T | undefined, R>

  Returns PromiseExtended<R>

firstKey

• firstKey(): PromiseExtended<IndexableType | undefined>

  Returns PromiseExtended<IndexableType | undefined>

keys

• keys(): PromiseExtended<IndexableTypeArray>

  Returns PromiseExtended<IndexableTypeArray>

• keys<R>(thenShortcut: ThenShortcut<IndexableTypeArray, R>): PromiseExtended<R>

  Type Parameters

  • R

  Parameters

  • thenShortcut: ThenShortcut<IndexableTypeArray, R>

  Returns PromiseExtended<R>

last

• last(): PromiseExtended<T | undefined>

  Returns PromiseExtended<T | undefined>

• last<R>(thenShortcut: ThenShortcut<T | undefined, R>): PromiseExtended<R>

  Type Parameters

  • R

  Parameters

  • thenShortcut: ThenShortcut<T | undefined, R>

  Returns PromiseExtended<R>

lastKey

• lastKey(): PromiseExtended<IndexableType | undefined>

  Returns PromiseExtended<IndexableType | undefined>

limit

• limit(n: number): Collection<T, Key, T>

  Parameters

  • n: number

  Returns Collection<T, Key, T>

modify

• modify(
      changeCallback: (obj: T, ctx: { value: T }) => boolean | void,
  ): PromiseExtended<number>

  Parameters

  • changeCallback: (obj: T, ctx: { value: T }) => boolean | void

  Returns PromiseExtended<number>

• modify(changes: UpdateSpec<TInsertType>): PromiseExtended<number>

  Parameters

  • changes: UpdateSpec<TInsertType>

  Returns PromiseExtended<number>

offset

• offset(n: number): Collection<T, Key, T>

  Parameters

  • n: number

  Returns Collection<T, Key, T>

or

• or(indexOrPrimayKey: string): WhereClause<T, Key, T>

  Parameters

  • indexOrPrimayKey: string

  Returns WhereClause<T, Key, T>

primaryKeys

• primaryKeys(): PromiseExtended<Key[]>

  Returns PromiseExtended<Key[]>

• primaryKeys<R>(thenShortcut: ThenShortcut<Key[], R>): PromiseExtended<R>

  Type Parameters

  • R

  Parameters

  • thenShortcut: ThenShortcut<Key[], R>

  Returns PromiseExtended<R>

raw

• raw(): Collection<T, Key, T>

  Returns Collection<T, Key, T>

reverse

• reverse(): Collection<T, Key, T>

  Returns Collection<T, Key, T>

sortBy

• sortBy(keyPath: string): PromiseExtended<T[]>

  Parameters

  • keyPath: string

  Returns PromiseExtended<T[]>

• sortBy<R>(
      keyPath: string,
      thenShortcut: ThenShortcut<T[], R>,
  ): PromiseExtended<R>

  Type Parameters

  • R

  Parameters

  • keyPath: string
  • thenShortcut: ThenShortcut<T[], R>

  Returns PromiseExtended<R>

toArray

• toArray(): PromiseExtended<T[]>

  Returns PromiseExtended<T[]>

• toArray<R>(thenShortcut: ThenShortcut<T[], R>): PromiseExtended<R>

  Type Parameters

  • R

  Parameters

  • thenShortcut: ThenShortcut<T[], R>

  Returns PromiseExtended<R>

uniqueKeys

• uniqueKeys(): PromiseExtended<IndexableTypeArray>

  Returns PromiseExtended<IndexableTypeArray>

• uniqueKeys<R>(
      thenShortcut: ThenShortcut<IndexableTypeArray, R>,
  ): PromiseExtended<R>

  Type Parameters

  • R

  Parameters

  • thenShortcut: ThenShortcut<IndexableTypeArray, R>

  Returns PromiseExtended<R>

until

• until(
      filter: (value: T) => boolean,
      includeStopEntry?: boolean,
  ): Collection<T, Key, T>

  Parameters

  • filter: (value: T) => boolean
  • OptionalincludeStopEntry: boolean

  Returns Collection<T, Key, T>