Class SessionCollection

Collection of Sessions

Hierarchy

ClassCollection<Session, HydratedSession>
- SessionCollection

Index

Constructors

constructor

new SessionCollection(client): SessionCollection
Create generic class collection
Parameters
- client: Client
  
  Client
Returns SessionCollection
Inherited from ClassCollection.constructor
- Defined in src/collections/Collection.ts:239

Properties

`Private` #objects

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

`Private` #storage

#storage: ObjectStorage<HydratedSession> = ...

`Readonly` client

client: Client

`Readonly` getUnderlyingObject

getUnderlyingObject: ((id) => HydratedSession)

Type declaration

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

`Readonly` updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedSession>>

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: Session
  
  Instance
- context: unknown
  
  Context
- Optional data: unknown
  
  Data
Returns void
Inherited from ClassCollection.create
- Defined in src/collections/Collection.ts:167

delete

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

deleteAll

deleteAll(revokeSelf?): Promise<void>
Delete all sessions, optionally including self
Parameters
- revokeSelf: boolean = false
  
  Whether to remove current session too
Returns Promise<void>
- Defined in src/collections/SessionCollection.ts:31

entries

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

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

fetch

fetch(): Promise<Session[]>
Fetch active sessions

Returns Promise<Session[]>
List of sessions
- Defined in src/collections/SessionCollection.ts:20

filter

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

find

find(predicate): undefined | Session
Find some value based on a predicate
Parameters
- predicate: ((value, key) => boolean)
  
  Predicate to satisfy
  - - (value, key): boolean
    - Parameters
      
      value: Session
      
      key: string
      
      Returns boolean
Returns undefined | Session
Inherited from ClassCollection.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: Session
      
      key: string
      
      map: ReactiveMap<string, Session>
      
      Returns void
Returns void
Iterable
Inherited from ClassCollection.forEach
- Defined in src/collections/Collection.ts:224

get

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

getOrCreate

getOrCreate(id, data): Session
Get or create
Parameters
- id: string
  
  Id
- data: {
  _id: string;
  name: string;
  }
  
  Data
  - _id: string
  - name: string
Returns Session
Session
- Defined in src/collections/SessionCollection.ts:48

has

has(id): boolean
Check whether an id exists in the Collection
Parameters
- id: string
  
  Id
Returns boolean
Whether it exists
Inherited from ClassCollection.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
Inherited from ClassCollection.isPartial
- Defined in src/collections/Collection.ts:183

keys

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

Returns IterableIterator<string>
Iterable
Inherited from ClassCollection.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: Session
      
      key: string
      
      Returns O
Returns O[]
Inherited from ClassCollection.map
- Defined in src/collections/Collection.ts:92

size

size(): number
Number of stored objects

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

toList

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

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

values

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

Returns IterableIterator<Session>
Iterable
Inherited from ClassCollection.values
- Defined in src/collections/Collection.ts:207

Class SessionCollection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns SessionCollection

Properties

Private #objects

Private #storage

Readonly client

Readonly getUnderlyingObject

Type declaration

Parameters

id: string

Returns HydratedSession

Readonly updateUnderlyingObject

Methods

create

Parameters

id: string

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

instance: Session

context: unknown

Optional data: unknown

Returns void

delete

Parameters

id: string

Returns void

deleteAll

Parameters

revokeSelf: boolean = false

Returns Promise<void>

entries

Returns IterableIterator<[string, Session]>

fetch

Returns Promise<Session[]>

filter

Parameters

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

Parameters

value: Session

key: string

Returns boolean

Returns Session[]

find

Parameters

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

Parameters

value: Session

key: string

Returns boolean

Returns undefined | Session

forEach

Parameters

cb: ((value, key, map) => void)

Parameters

value: Session

key: string

map: ReactiveMap<string, Session>

Returns void

Returns void

get

Parameters

id: string

Returns undefined | Session

getOrCreate

Parameters

id: string

data: { _id: string; name: string; }

_id: string

name: string

Returns Session

has

Parameters

`Private` #objects

`Private` #storage

`Readonly` client

`Readonly` getUnderlyingObject

`Readonly` updateUnderlyingObject

`Optional` data: unknown

data: {
_id: string;
name: string;
}