Class ChannelUnreadCollection

Collection of Channel Unreads

Hierarchy (View Summary)

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

`Readonly`client

client: Client

`Readonly`getUnderlyingObject

getUnderlyingObject: (id: string) => 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
- Optionaldata: 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 IterableIterator<[string, ChannelUnread]>
Iterable
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
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
Returns undefined | ChannelUnread
Inherited from ClassCollection.find
- Defined in src/collections/Collection.ts:105

for

for(channel: Channel): ChannelUnread
Get channel unread data for a specific Channel
Parameters
- channel: Channel
  Channel
Returns ChannelUnread
Unread
- Defined in src/collections/ChannelUnreadCollection.ts:58

forEach

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

get

get(id: string): undefined | ChannelUnread
Get an existing object
Parameters
- id: string
  Id
Returns undefined | ChannelUnread
Object
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?: string[];
    },
): ChannelUnread
Get or create
Parameters
- id: string
  Id
- data: {
      _id: { channel: string; user: string };
      last_id?: null | string;
      mentions?: 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
  - Optionallast_id?: null | string
    Description
    Id of the last message read in this channel by a user
  - Optionalmentions?: string[]
    Description
    Array of message ids that mention the user
Returns ChannelUnread
- Defined in src/collections/ChannelUnreadCollection.ts:43

has

has(id: string): 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: string): 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: (value: ChannelUnread, key: string) => O): O[]
Map the collection using a given callback
Type Parameters
- O
Parameters
- cb: (value: ChannelUnread, key: string) => O
  Callback
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:34

size

size(): number
Number of stored objects

Returns number
Size
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:21

toList

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

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

values

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

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

Class ChannelUnreadCollection

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ChannelUnreadCollection

Properties

Readonlyclient

ReadonlygetUnderlyingObject

ReadonlyupdateUnderlyingObject

Methods

create

Parameters

Returns void

delete

Parameters

Returns void

entries

Returns IterableIterator<[string, ChannelUnread]>

filter

Parameters

Returns ChannelUnread[]

find

Parameters

Returns undefined | ChannelUnread

for

Parameters

Returns ChannelUnread

forEach

Parameters

Returns void

get

Parameters

Returns undefined | ChannelUnread

getOrCreate

Parameters

_id: { channel: string; user: string }

Description

channel: string

Description

user: string

Description

Optionallast_id?: null | string

Description

Optionalmentions?: string[]

Description

Returns ChannelUnread

has

Parameters

Returns boolean

isPartial

Parameters

Returns boolean

keys

Returns IterableIterator<string>

map

Type Parameters

Parameters

Returns O[]

reset

Returns void

size

Returns number

sync

Returns Promise<void>

toList

Returns ChannelUnread[]

values

Returns IterableIterator<ChannelUnread>

On This Page

`Readonly`client

`Readonly`getUnderlyingObject

`Readonly`updateUnderlyingObject

`Optional`last_id?: null | string

`Optional`mentions?: string[]