Class ChannelUnreadCollection

Collection of Channel Unreads

Hierarchy

ClassCollection<ChannelUnread, HydratedChannelUnread>
- ChannelUnreadCollection

Index

Constructors

constructor

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

Properties

`Private` #objects

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

`Private` #storage

#storage: ObjectStorage<HydratedChannelUnread> = ...

`Readonly` client

client: Client

`Readonly` getUnderlyingObject

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

Type declaration

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

`Readonly` updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedChannelUnread>>

Methods

create

create(id: string, type: "user" | "server" | "channel" | "bot" | "channelUnread" | "channelWebhook" | "emoji" | "message" | "serverMember" | "session", instance: ChannelUnread, context: unknown, data?: unknown): 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: ChannelUnread
  
  Instance
- context: unknown
  
  Context
- Optional data: unknown
  
  Data
Returns void
Inherited from ClassCollection.create
- Defined in src/collections/Collection.ts:167

delete

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

entries

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

Returns
Iterable

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

filter

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

find

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

forEach

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

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

get

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

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

getOrCreate

getOrCreate(id: string, data: {
    _id: {
        channel: string;
        user: string;
    };
    last_id?: null | string;
    mentions?: null | string[];
}): ChannelUnread
Get or create
Parameters
- id: string
  
  Id
- data: {
      _id: {
          channel: string;
          user: string;
      };
      last_id?: null | string;
      mentions?: null | string[];
  }
  
  Data
  - _id: {
    channel: string;
    user: string;
    }
    
    Description
    Composite key pointing to a user's view of a channel
    - channel: string
      
      Description
      Channel Id
    - user: string
      
      Description
      User Id
  - Optional last_id?: null | string
    
    Description
    Id of the last message read in this channel by a user
  - Optional mentions?: null | string[]
    
    Description
    Array of message ids that mention the user
Returns ChannelUnread
- Defined in src/collections/ChannelUnreadCollection.ts:37

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 ClassCollection.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 ClassCollection.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 ClassCollection.keys
- Defined in src/collections/Collection.ts:199

map

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

reset

reset(): void
Clear all unread data

Returns void
- Defined in src/collections/ChannelUnreadCollection.ts:28

size

size(): number
Number of stored objects

Returns
Size

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

sync

sync(): Promise<void>
Load unread information from server

Returns Promise<void>
- Defined in src/collections/ChannelUnreadCollection.ts:17

toList

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

Returns
List

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

values

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

Returns
Iterable

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

Class ChannelUnreadCollection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns ChannelUnreadCollection

Properties

Private #objects

Private #storage

Readonly client

Readonly getUnderlyingObject

Type declaration

Parameters

id: string

Returns HydratedChannelUnread

Readonly updateUnderlyingObject

Methods

create

Parameters

id: string

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

instance: ChannelUnread

context: unknown

Optional data: unknown

Returns void

delete

Parameters

id: string

Returns void

entries

Returns

Returns IterableIterator<[string, ChannelUnread]>

filter

Parameters

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

Parameters

value: ChannelUnread

key: string

Returns boolean

Returns ChannelUnread[]

find

Parameters

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

Parameters

value: ChannelUnread

key: string

Returns boolean

Returns undefined | ChannelUnread

forEach

Returns

Parameters

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

Parameters

value: ChannelUnread

key: string

map: ReactiveMap<string, ChannelUnread>

Returns void

Returns void

get

Returns

Parameters

id: string

Returns undefined | ChannelUnread

getOrCreate

Parameters

id: string

data: { _id: { channel: string; user: string; }; last_id?: null | string; mentions?: null | string[]; }

_id: { channel: string; user: string; }

Description

channel: string

Description

user: string

Description

Optional last_id?: null | string

Description

`Private` #objects

`Private` #storage

`Readonly` client

`Readonly` getUnderlyingObject

`Readonly` updateUnderlyingObject

`Optional` data: unknown

data: {
_id: {
channel: string;
user: string;
};
last_id?: null | string;
mentions?: null | string[];
}

_id: {
channel: string;
user: string;
}

`Optional` last_id?: null | string

`Optional` mentions?: null | string[]