Class Channels

Channels Collection

Hierarchy

BaseClientCollection<string, Channel>
- Channels

Index

Constructors

constructor

Properties

Accessors

[Symbol.toStringTag]

Methods

Constructors

constructor

new Channels(client: ShardClient, options?: BaseClientCollectionOptions | boolean): Channels

Inherited from BaseClientCollection.constructor

Overrides BaseCollection.__constructor
- Defined in src/collections/basecollection.ts:175
Parameters
- client: ShardClient
- Default value options: BaseClientCollectionOptions | boolean = {}
Returns Channels

Properties

Optional _lastUsed

_lastUsed: Map<string, number>

cache

cache: Map<string, Channel>

client

client: ShardClient

enabled

enabled: boolean

Optional expire

expire: undefined | number

Optional interval

interval: Timers.Interval

intervalTime

intervalTime: number

lastUsed

lastUsed: Map<string, number>

length

length: number

limit

limit: number

shouldStartInterval

shouldStartInterval: boolean

size

size: number

Accessors

[Symbol.toStringTag]

get [Symbol.toStringTag](): string

Overrides BaseCollection.[Symbol.toStringTag]
- Defined in src/collections/channels.ts:27
Returns string

Methods

[Symbol.iterator]

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

Inherited from BaseCollection.[Symbol.iterator]

Overrides BaseCollectionMixin.[Symbol.iterator]
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:54
Returns IterableIterator<[string, Channel]>

clear

clear(): void

Inherited from BaseCollection.clear

Overrides BaseCollectionMixin.clear
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:45
Returns void

clone

clone(): BaseCollection<string, Channel>

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

delete

delete(key: string): boolean

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

entries

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

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

every

every(func: function): boolean

Inherited from BaseCollectionMixin.every
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:7
Parameters
- func: function
  - - (v: Channel, k: string): boolean
    - Parameters
      - v: Channel
      - k: string
      Returns boolean
Returns boolean

filter

filter(func: function): Array<Channel>

Inherited from BaseCollectionMixin.filter
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:8
Parameters
- func: function
  - - (v: Channel, k: string): boolean
    - Parameters
      - v: Channel
      - k: string
      Returns boolean
Returns Array<Channel>

find

find(func: function): Channel | undefined

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

first

first(): Channel | undefined

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

forEach

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

Inherited from BaseCollection.forEach

Overrides BaseCollectionMixin.forEach
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:48
Parameters
- func: function
  - - (v: Channel, k: string, map: Map<string, Channel>): void
    - Parameters
      - v: Channel
      - k: string
      - map: Map<string, Channel>
      Returns void
- Optional thisArg: any
Returns void

get

get(key: string): Channel | undefined

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

has

has(key: string): boolean

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

insert

insert(channel: Channel): void

- Defined in src/collections/channels.ts:21
Parameters
- channel: Channel
Returns void

join

join(separator?: undefined | string): string

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

keys

keys(): IterableIterator<string>

Inherited from BaseCollection.keys

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

map

map(func: function): Array<any>

Inherited from BaseCollectionMixin.map
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:13
Parameters
- func: function
  - - (v: Channel, k: string): any
    - Parameters
      - v: Channel
      - k: string
      Returns any
Returns Array<any>

reduce

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

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

set

set(key: string, value: Channel): this

Inherited from BaseCollection.set
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:52
Parameters
- key: string
- value: Channel
Returns this

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): this

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

setIntervalTimeout

setIntervalTimeout(value: number): this

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

some

some(func: function): boolean

Inherited from BaseCollectionMixin.some
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:15
Parameters
- func: function
  - - (v: Channel, k: string): boolean
    - Parameters
      - v: Channel
      - k: string
      Returns boolean
Returns boolean

sort

sort(func?: undefined | function): Array<Channel>

Inherited from BaseCollectionMixin.sort
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:16
Parameters
- Optional func: undefined | function
Returns Array<Channel>

startInterval

startInterval(): void

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

stopInterval

stopInterval(): void

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

toArray

toArray(): Array<Channel>

Inherited from BaseCollectionMixin.toArray
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:17
Returns Array<Channel>

toJSON

toJSON(): Array<Channel>

Inherited from BaseCollectionMixin.toJSON
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:18
Returns Array<Channel>

toString

toString(): string

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

values

values(): IterableIterator<Channel>

Inherited from BaseCollection.values

Overrides BaseCollectionMixin.values
- Defined in node_modules/detritus-utils/lib/basecollection.d.ts:53
Returns IterableIterator<Channel>

Generated using TypeDoc