Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TypingCollection

Typing Collection, a collection of users currently typing

Hierarchy

Index

Constructors

constructor

Properties

caches

caches: BaseCollection<K, BaseCollection<K, V>> = new BaseCollection<K, BaseCollection<K, V>>()

client

client: ShardClient

enabled

enabled: boolean

length

length: number

options

options: BaseCollectionOptions

Accessors

[Symbol.toStringTag]

  • get [Symbol.toStringTag](): string

size

  • get size(): number
  • Returns number

Methods

[Symbol.iterator]

  • [Symbol.iterator](): IterableIterator<[string, Typing]>

clear

  • clear(): void
  • Returns void

delete

  • delete(cacheKey: string): boolean
  • delete(cacheKey: string | null | undefined, key: string): boolean
  • Parameters

    • cacheKey: string

    Returns boolean

  • Parameters

    • cacheKey: string | null | undefined
    • key: string

    Returns boolean

entries

  • entries(): IterableIterator<[string, Typing]>
  • Returns IterableIterator<[string, Typing]>

every

  • every(func: function): boolean
  • Parameters

    • func: function
        • (v: Typing, k: string): boolean
        • Parameters

          Returns boolean

    Returns boolean

filter

  • filter(func: function): Array<Typing>
  • Parameters

    • func: function
        • (v: Typing, k: string): boolean
        • Parameters

          Returns boolean

    Returns Array<Typing>

find

  • find(func: function): Typing | undefined
  • Parameters

    • func: function
        • (v: Typing, k: string): boolean
        • Parameters

          Returns boolean

    Returns Typing | undefined

first

  • Returns Typing | undefined

forEach

  • forEach(func: function, thisArg?: any): void
  • Parameters

    • func: function
        • Parameters

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(cacheKey: string): BaseCollection<string, Typing> | undefined
  • get(cacheKey: string | null | undefined, key: string): Typing | undefined
  • Parameters

    • cacheKey: string

    Returns BaseCollection<string, Typing> | undefined

  • Parameters

    • cacheKey: string | null | undefined
    • key: string

    Returns Typing | undefined

has

  • has(cacheKey: string): boolean
  • has(cacheKey: string | null | undefined, key: string): boolean
  • Parameters

    • cacheKey: string

    Returns boolean

  • Parameters

    • cacheKey: string | null | undefined
    • key: string

    Returns boolean

insert

  • insert(typing: Typing): void
  • Parameters

    Returns void

insertCache

  • insertCache(cacheKey: string): BaseCollection<string, Typing>

join

  • join(separator?: undefined | string): string
  • Parameters

    • Optional separator: undefined | string

    Returns string

keys

  • keys(): IterableIterator<string>
  • Returns IterableIterator<string>

map

  • map(func: function): Array<any>
  • Parameters

    • func: function
        • Parameters

          Returns any

    Returns Array<any>

reduce

  • reduce(func: function, initialValue?: any): any
  • Parameters

    • func: function
        • (intial: any, v: Typing): any
        • Parameters

          Returns any

    • Optional initialValue: any

    Returns any

set

  • set(cacheKey: string, key: string, value: Typing): this
  • Parameters

    • cacheKey: string
    • key: string
    • value: Typing

    Returns this

setEnabled

  • setEnabled(value: boolean): void

some

  • some(func: function): boolean
  • Parameters

    • func: function
        • (v: Typing, k: string): boolean
        • Parameters

          Returns boolean

    Returns boolean

sort

  • sort(func?: undefined | function): Array<Typing>
  • Parameters

    • Optional func: undefined | function

    Returns Array<Typing>

toArray

  • Returns Array<Typing>

toJSON

  • Returns Array<Typing>

toString

  • toString(): string
  • Returns string

values

  • values(): IterableIterator<Typing>
  • Returns IterableIterator<Typing>

Generated using TypeDoc