Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICollection

Description of methods, what each collection instance will return.

Hierarchy

  • ICollection

Index

Properties

name

name: string

Name of current collection

Methods

add

addBulk

  • Bulk adding items in current collection instance. Method expected array of [collection items here. Item id is required in each array item for proper adding and future usage.

    Parameters

    Returns IResult | Promise<IResult>

clear

delete

deleteBulk

  • Delete more than on item by {@params keys} from current collection instance

    Parameters

    • Rest ...keys: string[]

    Returns IResult | Promise<IResult>

get

getAll

keys

  • keys(): string[] | Promise<string[]>
  • Get all current collection instance keys

    Returns string[] | Promise<string[]>

put

putBulk

  • Bulk updating items in current collection instance. Method expected an array of collection items here. Could be full item or it's part. Item id is required for proper updating.

    Parameters

    Returns IResult | Promise<IResult>

upsert

upsertBulk

  • Bulk updating or adding items in current collection instance. Method expected an array of collection items here. Could be full item or it's part. Item id is required for proper updating.

    Parameters

    Returns IResult | Promise<IResult>