Class ClassCollection<T, V>

Generic class collection backed by store

Type Parameters

Hierarchy

StoreCollection<T, V>
- ClassCollection

Index

Constructors

constructor

new ClassCollection<T, V>(client: Client): ClassCollection<T, V>
Create generic class collection
Type Parameters
- T
- V
Parameters
- client: Client
  
  Client
Returns ClassCollection<T, V>
Overrides StoreCollection.constructor
- Defined in src/collections/Collection.ts:239

Properties

`Private` #objects

#objects: ReactiveMap<string, T> = ...

`Private` #storage

#storage: ObjectStorage<V> = ...

`Readonly` client

client: Client

`Readonly` getUnderlyingObject

getUnderlyingObject: ((id: string) => V)

Type declaration

- (id: string): V
- Parameters
  - id: string
  Returns V

`Readonly` updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, V>>

Methods

create

create(id: string, type: "channel" | "user" | "server" | "bot" | "channelUnread" | "emoji" | "message" | "serverMember" | "session", instance: T, context: unknown, data?: unknown): void
Create a new instance of an object
Parameters
- id: string
  
  Id
- type: "channel" | "user" | "server" | "bot" | "channelUnread" | "emoji" | "message" | "serverMember" | "session"
  
  Type
- instance: T
  
  Instance
- context: unknown
  
  Context
- Optional data: unknown
  
  Data
Returns void
Inherited from StoreCollection.create
- Defined in src/collections/Collection.ts:167

delete

delete(id: string): void
Delete an object
Parameters
- id: string
  
  Id
Returns void
Inherited from StoreCollection.delete
- Defined in src/collections/Collection.ts:154

entries

entries(): IterableIterator<[string, T]>
Iterable of key, value pairs in the map

Returns
Iterable

Returns IterableIterator<[string, T]>
Inherited from StoreCollection.entries
- Defined in src/collections/Collection.ts:215

filter

filter(predicate: ((value: T, key: string) => boolean)): T[]
Filter the collection by a given predicate
Parameters
- predicate: ((value: T, key: string) => boolean)
  
  Predicate to satisfy
  - - (value: T, key: string): boolean
    - Parameters
      
      value: T
      
      key: string
      
      Returns boolean
Returns T[]
Inherited from StoreCollection.filter
- Defined in src/collections/Collection.ts:77

find

find(predicate: ((value: T, key: string) => boolean)): undefined | T
Find some value based on a predicate
Parameters
- predicate: ((value: T, key: string) => boolean)
  
  Predicate to satisfy
  - - (value: T, key: string): boolean
    - Parameters
      
      value: T
      
      key: string
      
      Returns boolean
Returns undefined | T
Inherited from StoreCollection.find
- Defined in src/collections/Collection.ts:105

forEach

forEach(cb: ((value: T, key: string, map: ReactiveMap<string, T>) => void)): void
Execute a provided function over each key, value pair in the map

Returns
Iterable
Parameters
- cb: ((value: T, key: string, map: ReactiveMap<string, T>) => void)
  
  Callback for each pair
  - - (value: T, key: string, map: ReactiveMap<string, T>): void
    - Parameters
      
      value: T
      
      key: string
      
      map: ReactiveMap<string, T>
      
      Returns void
Returns void
Inherited from StoreCollection.forEach
- Defined in src/collections/Collection.ts:224

get

get(id: string): undefined | T
Get an existing object

Returns
Object
Parameters
- id: string
  
  Id
Returns undefined | T
Inherited from StoreCollection.get
- Defined in src/collections/Collection.ts:137

has

has(id: string): boolean
Check whether an id exists in the Collection

Returns
Whether it exists
Parameters
- id: string
  
  Id
Returns boolean
Inherited from StoreCollection.has
- Defined in src/collections/Collection.ts:146

isPartial

isPartial(id: string): boolean
Check whether an object is partially defined

Returns
Whether it is a partial
Parameters
- id: string
  
  Id
Returns boolean
Inherited from StoreCollection.isPartial
- Defined in src/collections/Collection.ts:183

keys

keys(): IterableIterator<string>
Iterable of keys in the map

Returns
Iterable

Returns IterableIterator<string>
Inherited from StoreCollection.keys
- Defined in src/collections/Collection.ts:199

map

map<O>(cb: ((value: T, key: string) => O)): O[]
Map the collection using a given callback
Type Parameters
- O
Parameters
- cb: ((value: T, key: string) => O)
  
  Callback
  - - (value: T, key: string): O
    - Parameters
      
      value: T
      
      key: string
      
      Returns O
Returns O[]
Inherited from StoreCollection.map
- Defined in src/collections/Collection.ts:92

size

size(): number
Number of stored objects

Returns
Size

Returns number
Inherited from StoreCollection.size
- Defined in src/collections/Collection.ts:191

toList

toList(): T[]
List of values in the map

Returns
List

Returns T[]
Inherited from StoreCollection.toList
- Defined in src/collections/Collection.ts:69

values

values(): IterableIterator<T>
Iterable of values in the map

Returns
Iterable

Returns IterableIterator<T>
Inherited from StoreCollection.values
- Defined in src/collections/Collection.ts:207

Class ClassCollection<T, V>

Type Parameters

T

V

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

V

Parameters

client: Client

Returns ClassCollection<T, V>

Properties

Private #objects

Private #storage

Readonly client

Readonly getUnderlyingObject

Type declaration

Parameters

id: string

Returns V

Readonly updateUnderlyingObject

Methods

create

Parameters

id: string

type: "channel" | "user" | "server" | "bot" | "channelUnread" | "emoji" | "message" | "serverMember" | "session"

instance: T

context: unknown

Optional data: unknown

Returns void

delete

Parameters

id: string

Returns void

entries

Returns

Returns IterableIterator<[string, T]>

filter

Parameters

predicate: ((value: T, key: string) => boolean)

Parameters

value: T

key: string

Returns boolean

Returns T[]

find

Parameters

predicate: ((value: T, key: string) => boolean)

Parameters

value: T

key: string

Returns boolean

Returns undefined | T

forEach

Returns

Parameters

cb: ((value: T, key: string, map: ReactiveMap<string, T>) => void)

Parameters

value: T

key: string

map: ReactiveMap<string, T>

Returns void

Returns void

get

Returns

Parameters

id: string

Returns undefined | T

has

Returns

Parameters

id: string

Returns boolean

isPartial

`Private` #objects

`Private` #storage

`Readonly` client

`Readonly` getUnderlyingObject

`Readonly` updateUnderlyingObject

`Optional` data: unknown