Class MessageCollection

Collection of Messages

Hierarchy

ClassCollection<Message, HydratedMessage>
- MessageCollection

Index

Constructors

constructor

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

Properties

`Private` #objects

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

`Private` #storage

#storage: ObjectStorage<HydratedMessage> = ...

`Readonly` client

client: Client

`Readonly` getUnderlyingObject

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

Type declaration

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

`Readonly` updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedMessage>>

Methods

create

create(id: string, type: "user" | "server" | "channel" | "bot" | "channelUnread" | "channelWebhook" | "emoji" | "message" | "serverMember" | "session", instance: Message, 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: Message
  
  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, Message]>
Iterable of key, value pairs in the map

Returns
Iterable

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

fetch

fetch(channelId: string, messageId: string): Promise<Message>
Fetch message by Id

Returns
Message
Parameters
- channelId: string
  
  Channel Id
- messageId: string
  
  Message Id
Returns Promise<Message>
- Defined in src/collections/MessageCollection.ts:19

filter

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

find

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

forEach

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

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

get

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

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

getOrCreate

getOrCreate(id: string, data: {
    _id: string;
    attachments?: 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;
    }[];
    author: string;
    channel: string;
    content?: null | string;
    edited?: null | string;
    embeds?: null | ({
        colour?: null | string;
        description?: null | string;
        icon_url?: null | string;
        image?: null | {
            height: number;
            size: "Large" | "Preview";
            url: string;
            width: number;
        };
        original_url?: null | string;
        site_name?: null | string;
        special?: null | {
            type: "None";
        } | {
            type: "GIF";
        } | {
            id: string;
            timestamp?: null | string;
            type: "YouTube";
        } | {
            content_type: "Channel";
            id: string;
            type: "Lightspeed";
        } | {
            content_type: "Channel" | "Video" | "Clip";
            id: string;
            type: "Twitch";
        } | {
            content_type: string;
            id: string;
            type: "Spotify";
        } | {
            type: "Soundcloud";
        } | {
            content_type: "Album" | "Track";
            id: string;
            type: "Bandcamp";
        } | {
            id: string;
            type: "Streamable";
        };
        title?: null | string;
        type: "Website";
        url?: null | string;
        video?: null | {
            height: number;
            url: string;
            width: number;
        };
    } | {
        height: number;
        size: "Large" | "Preview";
        type: "Image";
        url: string;
        width: number;
    } | {
        height: number;
        type: "Video";
        url: string;
        width: number;
    } | {
        colour?: null | string;
        description?: null | string;
        icon_url?: null | string;
        media?: 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;
        };
        title?: null | string;
        type: "Text";
        url?: null | string;
    } | {
        type: "None";
    })[];
    interactions?: {
        reactions?: null | string[];
        restrict_reactions?: boolean;
    };
    masquerade?: null | {
        avatar?: null | string;
        colour?: null | string;
        name?: null | string;
    };
    mentions?: null | string[];
    nonce?: null | string;
    reactions?: {
        [key: string]: string[];
    };
    replies?: null | string[];
    system?: null | {
        content: string;
        type: "text";
    } | {
        by: string;
        id: string;
        type: "user_added";
    } | {
        by: string;
        id: string;
        type: "user_remove";
    } | {
        id: string;
        type: "user_joined";
    } | {
        id: string;
        type: "user_left";
    } | {
        id: string;
        type: "user_kicked";
    } | {
        id: string;
        type: "user_banned";
    } | {
        by: string;
        name: string;
        type: "channel_renamed";
    } | {
        by: string;
        type: "channel_description_changed";
    } | {
        by: string;
        type: "channel_icon_changed";
    } | {
        from: string;
        to: string;
        type: "channel_ownership_changed";
    };
    webhook?: null | {
        avatar?: null | string;
        name: string;
    };
}, isNew?: boolean): Message
Get or create
Parameters
- id: string
  
  Id
- data: {
      _id: string;
      attachments?: 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;
      }[];
      author: string;
      channel: string;
      content?: null | string;
      edited?: null | string;
      embeds?: null | ({
          colour?: null | string;
          description?: null | string;
          icon_url?: null | string;
          image?: null | {
              height: number;
              size: "Large" | "Preview";
              url: string;
              width: number;
          };
          original_url?: null | string;
          site_name?: null | string;
          special?: null | {
              type: "None";
          } | {
              type: "GIF";
          } | {
              id: string;
              timestamp?: null | string;
              type: "YouTube";
          } | {
              content_type: "Channel";
              id: string;
              type: "Lightspeed";
          } | {
              content_type: "Channel" | "Video" | "Clip";
              id: string;
              type: "Twitch";
          } | {
              content_type: string;
              id: string;
              type: "Spotify";
          } | {
              type: "Soundcloud";
          } | {
              content_type: "Album" | "Track";
              id: string;
              type: "Bandcamp";
          } | {
              id: string;
              type: "Streamable";
          };
          title?: null | string;
          type: "Website";
          url?: null | string;
          video?: null | {
              height: number;
              url: string;
              width: number;
          };
      } | {
          height: number;
          size: "Large" | "Preview";
          type: "Image";
          url: string;
          width: number;
      } | {
          height: number;
          type: "Video";
          url: string;
          width: number;
      } | {
          colour?: null | string;
          description?: null | string;
          icon_url?: null | string;
          media?: 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;
          };
          title?: null | string;
          type: "Text";
          url?: null | string;
      } | {
          type: "None";
      })[];
      interactions?: {
          reactions?: null | string[];
          restrict_reactions?: boolean;
      };
      masquerade?: null | {
          avatar?: null | string;
          colour?: null | string;
          name?: null | string;
      };
      mentions?: null | string[];
      nonce?: null | string;
      reactions?: {
          [key: string]: string[];
      };
      replies?: null | string[];
      system?: null | {
          content: string;
          type: "text";
      } | {
          by: string;
          id: string;
          type: "user_added";
      } | {
          by: string;
          id: string;
          type: "user_remove";
      } | {
          id: string;
          type: "user_joined";
      } | {
          id: string;
          type: "user_left";
      } | {
          id: string;
          type: "user_kicked";
      } | {
          id: string;
          type: "user_banned";
      } | {
          by: string;
          name: string;
          type: "channel_renamed";
      } | {
          by: string;
          type: "channel_description_changed";
      } | {
          by: string;
          type: "channel_icon_changed";
      } | {
          from: string;
          to: string;
          type: "channel_ownership_changed";
      };
      webhook?: null | {
          avatar?: null | string;
          name: string;
      };
  }
  
  Data
  - _id: string
    
    Description
    Unique Id
  - Optional attachments?: 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;
    }[]
    
    Description
    Array of attachments
  - author: string
    
    Description
    Id of the user or webhook that sent this message
  - channel: string
    
    Description
    Id of the channel this message was sent in
  - Optional content?: null | string
    
    Description
    Message content
  - Optional edited?: null | string
    
    Description
    Time at which this message was last edited
  - Optional embeds?: null | ({
        colour?: null | string;
        description?: null | string;
        icon_url?: null | string;
        image?: null | {
            height: number;
            size: "Large" | "Preview";
            url: string;
            width: number;
        };
        original_url?: null | string;
        site_name?: null | string;
        special?: null | {
            type: "None";
        } | {
            type: "GIF";
        } | {
            id: string;
            timestamp?: null | string;
            type: "YouTube";
        } | {
            content_type: "Channel";
            id: string;
            type: "Lightspeed";
        } | {
            content_type: "Channel" | "Video" | "Clip";
            id: string;
            type: "Twitch";
        } | {
            content_type: string;
            id: string;
            type: "Spotify";
        } | {
            type: "Soundcloud";
        } | {
            content_type: "Album" | "Track";
            id: string;
            type: "Bandcamp";
        } | {
            id: string;
            type: "Streamable";
        };
        title?: null | string;
        type: "Website";
        url?: null | string;
        video?: null | {
            height: number;
            url: string;
            width: number;
        };
    } | {
        height: number;
        size: "Large" | "Preview";
        type: "Image";
        url: string;
        width: number;
    } | {
        height: number;
        type: "Video";
        url: string;
        width: number;
    } | {
        colour?: null | string;
        description?: null | string;
        icon_url?: null | string;
        media?: 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;
        };
        title?: null | string;
        type: "Text";
        url?: null | string;
    } | {
        type: "None";
    })[]
    
    Description
    Attached embeds to this message
  - Optional interactions?: {
    reactions?: null | string[];
    restrict_reactions?: boolean;
    }
    
    Description
    Information about how this message should be interacted with
    - Optional reactions?: null | string[]
      
      Description
      Reactions which should always appear and be distinct
    - Optional restrict_reactions?: boolean
      
      Description
      Whether reactions should be restricted to the given list
      
      Can only be set to true if reactions list is of at least length 1
  - Optional masquerade?: null | {
        avatar?: null | string;
        colour?: null | string;
        name?: null | string;
    }
    
    Description
    Name and / or avatar overrides for this message
  - Optional mentions?: null | string[]
    
    Description
    Array of user ids mentioned in this message
  - Optional nonce?: null | string
    
    Description
    Unique value generated by client sending this message
  - Optional reactions?: {
    [key: string]: string[];
    }
    
    Description
    Hashmap of emoji IDs to array of user IDs
    - [key: string]: string[]
  - Optional replies?: null | string[]
    
    Description
    Array of message ids this message is replying to
  - Optional system?: null | {
        content: string;
        type: "text";
    } | {
        by: string;
        id: string;
        type: "user_added";
    } | {
        by: string;
        id: string;
        type: "user_remove";
    } | {
        id: string;
        type: "user_joined";
    } | {
        id: string;
        type: "user_left";
    } | {
        id: string;
        type: "user_kicked";
    } | {
        id: string;
        type: "user_banned";
    } | {
        by: string;
        name: string;
        type: "channel_renamed";
    } | {
        by: string;
        type: "channel_description_changed";
    } | {
        by: string;
        type: "channel_icon_changed";
    } | {
        from: string;
        to: string;
        type: "channel_ownership_changed";
    }
    
    Description
    System message
  - Optional webhook?: null | {
    avatar?: null | string;
    name: string;
    }
    
    Description
    The webhook that sent this message
- isNew: boolean = false
  
  Whether this object is new
Returns Message
- Defined in src/collections/MessageCollection.ts:36

getOrPartial

getOrPartial(id: string): undefined | Message
Get or return partial
Parameters
- id: string
  
  Id
Returns undefined | Message
- Defined in src/collections/MessageCollection.ts:51

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

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

toList

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

Returns
List

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

values

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

Returns
Iterable

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

Class MessageCollection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns MessageCollection

Properties

Private #objects

Private #storage

Readonly client

Readonly getUnderlyingObject

Type declaration

Parameters

id: string

Returns HydratedMessage

Readonly updateUnderlyingObject

Methods

create

Parameters

id: string

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

instance: Message

context: unknown

Optional data: unknown

Returns void

delete

Parameters

id: string

Returns void

entries

Returns

Returns IterableIterator<[string, Message]>

fetch

Returns

Parameters

channelId: string

messageId: string

Returns Promise<Message>

filter

Parameters

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

Parameters

value: Message

key: string

Returns boolean

Returns Message[]

find

Parameters

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

Parameters

value: Message

key: string

Returns boolean

Returns undefined | Message

forEach

Returns

Parameters

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

Parameters

value: Message

key: string

map: ReactiveMap<string, Message>

Returns void

Returns void

get

Returns

Parameters

id: string

Returns undefined | Message

getOrCreate

Parameters

id: string

_id: string

Description

Description

`Private` #objects

`Private` #storage

`Readonly` client

`Readonly` getUnderlyingObject

`Readonly` updateUnderlyingObject

`Optional` data: unknown

`Optional` content?: null | string

`Optional` edited?: null | string

`Optional` interactions?: {
reactions?: null | string[];
restrict_reactions?: boolean;
}

`Optional` reactions?: null | string[]

`Optional` restrict_reactions?: boolean

`Optional` masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
}

`Optional` mentions?: null | string[]

`Optional` nonce?: null | string

`Optional` reactions?: {
[key: string]: string[];
}

`Optional` replies?: null | string[]

`Optional` webhook?: null | {
avatar?: null | string;
name: string;
}