Class Interactions

Interactions Collection

Hierarchy

BaseClientCollection<string, Interaction>
- Interactions

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Interactions(client: ShardClient, options?: boolean | InteractionsOptions): Interactions

Overrides BaseClientCollection.constructor
- Defined in src/collections/interactions.ts:27
Parameters
- client: ShardClient
- options: boolean | InteractionsOptions = {}
Returns Interactions

Properties

Optional _lastUsed

_lastUsed: Map<string, number>

Readonly cache

cache: Map<string, Interaction>

client

client: ShardClient

enabled

enabled: boolean

Optional expire

expire: number

Optional interval

interval: Interval

intervalTime

intervalTime: number

limit

limit: number

Accessors

[Symbol.toStringTag]

get [Symbol.toStringTag](): string

- Defined in src/collections/interactions.ts:41
Returns string

lastUsed

get lastUsed(): Map<K, number>

- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:38
Returns Map<K, number>

length

get length(): number

- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:3
Returns number

shouldStartInterval

get shouldStartInterval(): boolean

- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:39
Returns boolean

size

get size(): number

- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:44
Returns number

Methods

[Symbol.iterator]

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

Inherited from BaseClientCollection.[Symbol.iterator]
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:54
Returns IterableIterator<[string, Interaction]>

clear

clear(): void

Inherited from BaseClientCollection.clear
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:45
Returns void

clone

clone(): BaseCollection<string, Interaction>

Inherited from BaseClientCollection.clone
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:46
Returns BaseCollection<string, Interaction>

delete

delete(key: string): boolean

Inherited from BaseClientCollection.delete
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:47
Parameters
- key: string
Returns boolean

entries

entries(): IterableIterator<[string, Interaction]>

Inherited from BaseClientCollection.entries
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:6
Returns IterableIterator<[string, Interaction]>

every

every(func: (v: Interaction, k: string) => boolean): boolean

Inherited from BaseClientCollection.every
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:7
Parameters
- func: (v: Interaction, k: string) => boolean
  - - (v: Interaction, k: string): boolean
    - Parameters
      - v: Interaction
      - k: string
      Returns boolean
Returns boolean

filter

filter(func: (v: Interaction, k: string) => boolean): Interaction[]

Inherited from BaseClientCollection.filter
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:8
Parameters
- func: (v: Interaction, k: string) => boolean
  - - (v: Interaction, k: string): boolean
    - Parameters
      - v: Interaction
      - k: string
      Returns boolean
Returns Interaction[]

find

find(func: (v: Interaction, k: string) => boolean): undefined | Interaction

Inherited from BaseClientCollection.find
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:9
Parameters
- func: (v: Interaction, k: string) => boolean
  - - (v: Interaction, k: string): boolean
    - Parameters
      - v: Interaction
      - k: string
      Returns boolean
Returns undefined | Interaction

first

first(): undefined | Interaction

Inherited from BaseClientCollection.first
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:10
Returns undefined | Interaction

forEach

forEach(func: (v: Interaction, k: string, map: Map<string, Interaction>) => void, thisArg?: any): void

Inherited from BaseClientCollection.forEach
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:48
Parameters
- func: (v: Interaction, k: string, map: Map<string, Interaction>) => void
  - - (v: Interaction, k: string, map: Map<string, Interaction>): void
    - Parameters
      - v: Interaction
      - k: string
      - map: Map<string, Interaction>
      Returns void
- Optional thisArg: any
Returns void

get

get(key: string): undefined | Interaction

Inherited from BaseClientCollection.get
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:49
Parameters
- key: string
Returns undefined | Interaction

has

has(key: string): boolean

Inherited from BaseClientCollection.has
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:50
Parameters
- key: string
Returns boolean

insert

insert(interaction: Interaction): void

- Defined in src/collections/interactions.ts:35
Parameters
- interaction: Interaction
Returns void

join

join(separator?: string): string

Inherited from BaseClientCollection.join
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:12
Parameters
- Optional separator: string
Returns string

keys

keys(): IterableIterator<string>

Inherited from BaseClientCollection.keys
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:51
Returns IterableIterator<string>

map

map(func: (v: Interaction, k: string) => any): any[]

Inherited from BaseClientCollection.map
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:13
Parameters
- func: (v: Interaction, k: string) => any
  - - (v: Interaction, k: string): any
    - Parameters
      - v: Interaction
      - k: string
      Returns any
Returns any[]

reduce

reduce(func: (intial: any, v: Interaction) => any, initialValue?: any): any

Inherited from BaseClientCollection.reduce
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:14
Parameters
- func: (intial: any, v: Interaction) => any
  - - (intial: any, v: Interaction): any
    - Parameters
      - intial: any
      - v: Interaction
      Returns any
- Optional initialValue: any
Returns any

set

set(key: string, value: Interaction): Interactions

Inherited from BaseClientCollection.set
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:52
Parameters
- key: string
- value: Interaction
Returns Interactions

setEnabled

setEnabled(value: boolean): void

Inherited from BaseClientCollection.setEnabled
- Defined in src/collections/basecollection.ts:195
Parameters
- value: boolean
Returns void

setExpire

setExpire(value: number): Interactions

Inherited from BaseClientCollection.setExpire
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:40
Parameters
- value: number
Returns Interactions

setIntervalTimeout

setIntervalTimeout(value: number): Interactions

Inherited from BaseClientCollection.setIntervalTimeout
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:41
Parameters
- value: number
Returns Interactions

some

some(func: (v: Interaction, k: string) => boolean): boolean

Inherited from BaseClientCollection.some
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:15
Parameters
- func: (v: Interaction, k: string) => boolean
  - - (v: Interaction, k: string): boolean
    - Parameters
      - v: Interaction
      - k: string
      Returns boolean
Returns boolean

sort

sort(func?: (x: Interaction, y: Interaction) => number): Interaction[]

Inherited from BaseClientCollection.sort
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:16
Parameters
- Optional func: (x: Interaction, y: Interaction) => number
  - - (x: Interaction, y: Interaction): number
    - Parameters
      - x: Interaction
      - y: Interaction
      Returns number
Returns Interaction[]

startInterval

startInterval(): void

Inherited from BaseClientCollection.startInterval
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:42
Returns void

stopInterval

stopInterval(): void

Inherited from BaseClientCollection.stopInterval
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:43
Returns void

toArray

toArray(): Interaction[]

Inherited from BaseClientCollection.toArray
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:17
Returns Interaction[]

toJSON

toJSON(): Interaction[]

Inherited from BaseClientCollection.toJSON
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:18
Returns Interaction[]

toString

toString(): string

Inherited from BaseClientCollection.toString
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:19
Returns string

values

values(): IterableIterator<Interaction>

Inherited from BaseClientCollection.values
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:53
Returns IterableIterator<Interaction>

Generated using TypeDoc