Class StoreCollection<T, V>`Abstract`

Collection backed by a Solid.js Store

Type Parameters

T
V

Hierarchy

Collection<T>
- StoreCollection
  - ClassCollection

Index

Constructors

Properties

#objects #storage getUnderlyingObject updateUnderlyingObject

Methods

create delete entries filter find forEach get has isPartial keys map size toList values

Constructors

constructor

new StoreCollection<T, V>(): StoreCollection<T, V>
Construct store backed collection
Type Parameters
- T
- V
Returns StoreCollection<T, V>
Overrides Collection.constructor
- Defined in src/collections/Collection.ts:126

Properties

`Private` #objects

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

`Private` #storage

#storage: ObjectStorage<V> = ...

`Readonly` getUnderlyingObject

getUnderlyingObject: ((id) => V)

Type declaration

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

`Readonly` updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, V>>

Methods

create

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

delete

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

entries

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

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

filter

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

find

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

forEach

forEach(cb): void
Execute a provided function over each key, value pair in the map
Parameters
- cb: ((value, key, map) => void)
  
  Callback for each pair
  - - (value, key, map): void
    - Parameters
      
      value: T
      
      key: string
      
      map: ReactiveMap<string, T>
      
      Returns void
Returns void
Iterable
Overrides Collection.forEach
- Defined in src/collections/Collection.ts:224

get

get(id): undefined | T
Get an existing object
Parameters
- id: string
  
  Id
Returns undefined | T
Object
Overrides Collection.get
- Defined in src/collections/Collection.ts:137

has

has(id): boolean
Check whether an id exists in the Collection
Parameters
- id: string
  
  Id
Returns boolean
Whether it exists
Overrides Collection.has
- Defined in src/collections/Collection.ts:146

isPartial

isPartial(id): boolean
Check whether an object is partially defined
Parameters
- id: string
  
  Id
Returns boolean
Whether it is a partial
- Defined in src/collections/Collection.ts:183

keys

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

Returns IterableIterator<string>
Iterable
Overrides Collection.keys
- Defined in src/collections/Collection.ts:199

map

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

size

size(): number
Number of stored objects

Returns number
Size
Overrides Collection.size
- Defined in src/collections/Collection.ts:191

toList

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

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

values

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

Returns IterableIterator<T>
Iterable
Overrides Collection.values
- Defined in src/collections/Collection.ts:207

Generated using TypeDoc