Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Collection<key, stores>

Type parameters

  • key

  • stores

Hierarchy

  • Map<key, stores>
    • Collection

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

[Symbol.toStringTag]

[Symbol.toStringTag]: string

client

client: Client

size

size: number

Static Map

Map: MapConstructor

Methods

[Symbol.iterator]

  • [Symbol.iterator](): IterableIterator<[key, stores]>

  • Returns IterableIterator<[key, stores]>

array

  • array(): Array<stores>

clear

  • clear(): void

  • Returns void

delete

  • delete(key: key): boolean

  • Parameters

    • key: key

    Returns boolean

entries

  • entries(): IterableIterator<[key, stores]>

  • Returns IterableIterator<[key, stores]>

filter

  • filter(filterFunction: Function): Collection<key, stores>

filterKeys

  • filterKeys(filterFunction: Function): Collection<key, stores>

first

  • first(): stores

firstKey

  • firstKey(): key

forEach

  • forEach(callbackfn: function, thisArg: any): void

  • Parameters

    • callbackfn: function
        • (value: stores, key: key, map: Map<key, stores>): void

        • Parameters

          • value: stores
          • key: key
          • map: Map<key, stores>

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key: key): stores | undefined

  • Parameters

    • key: key

    Returns stores | undefined

has

  • has(key: key): boolean

  • Parameters

    • key: key

    Returns boolean

includes

  • includes(search: stores): boolean

includesKey

  • includesKey(search: key): boolean

keyArray

  • keyArray(): Array<key>

keys

  • keys(): IterableIterator<key>

  • Returns IterableIterator<key>

last

  • last(count: number): stores | Array<stores>

lastKey

  • lastKey(count: number): key | Array<key>

set

  • set(key: key, value: stores): this

  • Parameters

    • key: key
    • value: stores

    Returns this

values

  • values(): IterableIterator<stores>

  • Returns IterableIterator<stores>

Generated using TypeDoc