Class ChannelCollection

Collection of Channels

Hierarchy

ClassCollection<Channel, HydratedChannel>
- ChannelCollection

Index

Constructors

constructor

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

Properties

`Private` #objects

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

`Private` #storage

#storage: ObjectStorage<HydratedChannel> = ...

`Readonly` client

client: Client

`Readonly` getUnderlyingObject

getUnderlyingObject: ((id) => HydratedChannel)

Type declaration

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

`Readonly` updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedChannel>>

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

createGroup

createGroup(name, users): Promise<Channel>
Create a group
Parameters
- name: string
  
  Group name
- users: (string | User)[]
  
  Users to add
Returns Promise<Channel>
The newly-created group
- Defined in src/collections/ChannelCollection.ts:75

delete

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

entries

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

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

fetch

fetch(id): Promise<Channel>
Fetch channel by ID
Parameters
- id: string
  
  Id
Returns Promise<Channel>
Channel
- Defined in src/collections/ChannelCollection.ts:28

filter

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

find

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

get

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

getOrCreate

getOrCreate(id, data, isNew?): Channel
Get or create
Parameters
- id: string
  
  Id
- data: {
      _id: string;
      channel_type: "SavedMessages";
      user: string;
  } | {
      _id: string;
      active: boolean;
      channel_type: "DirectMessage";
      last_message_id?: null | string;
      recipients: string[];
  } | {
      _id: string;
      channel_type: "Group";
      description?: null | string;
      icon?: null | {
          _id: string;
          content_type: string;
          deleted?: null | boolean;
          filename: string;
          message_id?: null | string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: null | string;
          reported?: null | boolean;
          server_id?: null | string;
          size: number;
          tag: string;
          user_id?: null | string;
      };
      last_message_id?: null | string;
      name: string;
      nsfw?: boolean;
      owner: string;
      permissions?: null | number;
      recipients: string[];
  } | {
      _id: string;
      channel_type: "TextChannel";
      default_permissions?: null | {
          a: number;
          d: number;
      };
      description?: null | string;
      icon?: null | {
          _id: string;
          content_type: string;
          deleted?: null | boolean;
          filename: string;
          message_id?: null | string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: null | string;
          reported?: null | boolean;
          server_id?: null | string;
          size: number;
          tag: string;
          user_id?: null | string;
      };
      last_message_id?: null | string;
      name: string;
      nsfw?: boolean;
      role_permissions?: {
          [key: string]: components["schemas"]["OverrideField"];
      };
      server: string;
  } | {
      _id: string;
      channel_type: "VoiceChannel";
      default_permissions?: null | {
          a: number;
          d: number;
      };
      description?: null | string;
      icon?: null | {
          _id: string;
          content_type: string;
          deleted?: null | boolean;
          filename: string;
          message_id?: null | string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: null | string;
          reported?: null | boolean;
          server_id?: null | string;
          size: number;
          tag: string;
          user_id?: null | string;
      };
      name: string;
      nsfw?: boolean;
      role_permissions?: {
          [key: string]: components["schemas"]["OverrideField"];
      };
      server: string;
  }
  
  Data
- isNew: boolean = false
  
  Whether this object is new
Returns Channel
- Defined in src/collections/ChannelCollection.ts:41

getOrPartial

getOrPartial(id): undefined | Channel
Get or return partial
Parameters
- id: string
  
  Id
Returns undefined | Channel
- Defined in src/collections/ChannelCollection.ts:56

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: Channel
      
      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(): Channel[]
List of values in the map

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

values

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

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

Class ChannelCollection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns ChannelCollection

Properties

Private #objects

Private #storage

Readonly client

Readonly getUnderlyingObject

Type declaration

Parameters

id: string

Returns HydratedChannel

Readonly updateUnderlyingObject

Methods

create

Parameters

id: string

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

instance: Channel

context: unknown

Optional data: unknown

Returns void

createGroup

Parameters

name: string

users: (string | User)[]

Returns Promise<Channel>

delete

Parameters

id: string

Returns void

entries

Returns IterableIterator<[string, Channel]>

fetch

Parameters

id: string

Returns Promise<Channel>

filter

Parameters

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

Parameters

value: Channel

key: string

Returns boolean

Returns Channel[]

find

Parameters

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

Parameters

value: Channel

key: string

Returns boolean

Returns undefined | Channel

forEach

Parameters

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

Parameters

value: Channel

key: string

map: ReactiveMap<string, Channel>

Returns void

Returns void

get

Parameters

id: string

Returns undefined | Channel

getOrCreate

Parameters

id: string

isNew: boolean = false

Returns Channel

getOrPartial

`Private` #objects

`Private` #storage

`Readonly` client

`Readonly` getUnderlyingObject

`Readonly` updateUnderlyingObject

`Optional` data: unknown