From 5f07620f2a4f10cb1cd643991806b69fcdef2d09 Mon Sep 17 00:00:00 2001 From: insertish Date: Fri, 19 May 2023 20:34:10 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20docs=20from=20@=20revoltchat/r?= =?UTF-8?q?evolt.js@55b8b2b0c80b032874c38f83a2a3bbd796e32667=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/Bot.html | 38 +++--- classes/BotCollection.html | 52 ++++---- classes/Channel.html | 120 +++++++++--------- classes/ChannelCollection.html | 50 ++++---- classes/ChannelEditSystemMessage.html | 14 +- classes/ChannelInvite.html | 10 +- .../ChannelOwnershipChangeSystemMessage.html | 18 +-- classes/ChannelRenamedSystemMessage.html | 16 +-- classes/ChannelUnread.html | 12 +- classes/ChannelUnreadCollection.html | 48 +++---- classes/ClassCollection.html | 42 +++--- classes/Client.html | 64 +++++----- classes/Collection.html | 26 ++-- classes/Emoji.html | 24 ++-- classes/EmojiCollection.html | 48 +++---- classes/EventClient.html | 34 ++--- classes/File.html | 28 ++-- classes/ImageEmbed.html | 20 +-- classes/Message.html | 72 +++++------ classes/MessageCollection.html | 50 ++++---- classes/MessageEmbed.html | 10 +- classes/PublicBot.html | 18 +-- classes/PublicChannelInvite.html | 10 +- classes/Server.html | 108 ++++++++-------- classes/ServerBan.html | 16 +-- classes/ServerCollection.html | 50 ++++---- classes/ServerInvite.html | 26 ++-- classes/ServerMember.html | 48 +++---- classes/ServerMemberCollection.html | 52 ++++---- classes/ServerPublicInvite.html | 36 +++--- classes/Session.html | 20 +-- classes/SessionCollection.html | 48 +++---- classes/StoreCollection.html | 40 +++--- classes/SystemMessage.html | 10 +- classes/TextEmbed.html | 24 ++-- classes/TextSystemMessage.html | 12 +- classes/UnknownEmbed.html | 10 +- classes/UnknownInvite.html | 10 +- classes/UnknownPublicInvite.html | 10 +- classes/User.html | 60 ++++----- classes/UserCollection.html | 48 +++---- classes/UserModeratedSystemMessage.html | 18 +-- classes/UserSystemMessage.html | 14 +- classes/VideoEmbed.html | 18 +-- classes/WebsiteEmbed.html | 34 ++--- enums/BotFlags.html | 2 +- enums/ConnectionState.html | 10 +- enums/ServerFlags.html | 6 +- enums/UserBadges.html | 24 ++-- enums/UserFlags.html | 8 +- types/ClientOptions.html | 2 +- types/PrivateSession.html | 2 +- variables/RE_CHANNELS.html | 2 +- variables/RE_MENTIONS.html | 2 +- variables/RE_SPOILER.html | 2 +- 55 files changed, 798 insertions(+), 798 deletions(-) diff --git a/classes/Bot.html b/classes/Bot.html index e0f0e4ba..2f8730db 100644 --- a/classes/Bot.html +++ b/classes/Bot.html @@ -35,7 +35,7 @@ +
  • Defined in src/classes/Bot.ts:9
    • @@ -93,19 +93,19 @@

    Returns Bot

    +
  • Defined in src/classes/Bot.ts:18

    • Properties

    Private Readonly #collection

    #collection: BotCollection
    +
  • Defined in src/classes/Bot.ts:10

    • Readonly id

    id: string
    +
  • Defined in src/classes/Bot.ts:11

    • Accessors

    @@ -117,7 +117,7 @@

    Returns boolean

    +
  • Defined in src/classes/Bot.ts:76

    • createdAt

    +
  • Defined in src/classes/Bot.ts:34

    • discoverable

    +
  • Defined in src/classes/Bot.ts:83

    • flags

    +
  • Defined in src/classes/Bot.ts:111

    • interactionsUrl

    +
  • Defined in src/classes/Bot.ts:90

    • owner

    +
  • Defined in src/classes/Bot.ts:55

    • ownerId

    +
  • Defined in src/classes/Bot.ts:48

    • privacyPolicyUrl

    +
  • Defined in src/classes/Bot.ts:104

    • public

    +
  • Defined in src/classes/Bot.ts:69

    • termsOfServiceUrl

    +
  • Defined in src/classes/Bot.ts:97

    • token

    +
  • Defined in src/classes/Bot.ts:62

    • user

    +
  • Defined in src/classes/Bot.ts:41

    • Methods

    @@ -239,7 +239,7 @@

    Returns Promise<void>

    +
  • Defined in src/classes/Bot.ts:126

    • edit

    Returns Promise<void>

    +
  • Defined in src/classes/Bot.ts:119

    • toString

    +
  • Defined in src/classes/Bot.ts:27
    • diff --git a/classes/BotCollection.html b/classes/BotCollection.html index 06d1d983..ec25a52a 100644 --- a/classes/BotCollection.html +++ b/classes/BotCollection.html @@ -37,7 +37,7 @@
    • BotCollection
    +
  • Defined in src/collections/BotCollection.ts:13
    • @@ -96,7 +96,7 @@

    Returns BotCollection

    +
  • Defined in src/collections/Collection.ts:239

    • Properties

    @@ -104,19 +104,19 @@
    #objects: ReactiveMap<string, Bot> = ...
    +
  • Defined in src/collections/Collection.ts:119

    • Private #storage

    #storage: ObjectStorage<HydratedBot> = ...
    +
  • Defined in src/collections/Collection.ts:118

    • Readonly client

    client: Client
    +
  • Defined in src/collections/Collection.ts:233

    • Readonly getUnderlyingObject

    getUnderlyingObject: ((id: string) => HydratedBot)
    @@ -135,13 +135,13 @@

    Returns HydratedBot

    +
  • Defined in src/collections/Collection.ts:120

    • Readonly updateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedBot>>
    +
  • Defined in src/collections/Collection.ts:121

    • Methods

    @@ -177,7 +177,7 @@

    Returns void

    +
  • Defined in src/collections/Collection.ts:167

    • createBot

      @@ -196,7 +196,7 @@

    Returns Promise<Bot>

    +
  • Defined in src/collections/BotCollection.ts:72

    • delete

    +
  • Defined in src/collections/Collection.ts:154

    • entries

    +
  • Defined in src/collections/Collection.ts:215

    • fetch

    Returns Promise<Bot>

    +
  • Defined in src/collections/BotCollection.ts:19

    • fetchOwned

    +
  • Defined in src/collections/BotCollection.ts:31

    • fetchPublic

    Returns Promise<PublicBot>

    +
  • Defined in src/collections/BotCollection.ts:46

    • filter

    +
  • Defined in src/collections/Collection.ts:77

    • find

    +
  • Defined in src/collections/Collection.ts:105

    • forEach

    +
  • Defined in src/collections/Collection.ts:224

    • get

    +
  • Defined in src/collections/Collection.ts:137

    • getOrCreate

    Returns Bot

    +
  • Defined in src/collections/BotCollection.ts:57

    • has

    +
  • Defined in src/collections/Collection.ts:146

    • isPartial

    +
  • Defined in src/collections/Collection.ts:183

    • keys

    +
  • Defined in src/collections/Collection.ts:199

    • map

    +
  • Defined in src/collections/Collection.ts:92

    • size

    +
  • Defined in src/collections/Collection.ts:191

    • toList

    +
  • Defined in src/collections/Collection.ts:69

    • values

    +
  • Defined in src/collections/Collection.ts:207
    • diff --git a/classes/Channel.html b/classes/Channel.html index ea53bdda..823b68fe 100644 --- a/classes/Channel.html +++ b/classes/Channel.html @@ -35,7 +35,7 @@
    • Channel
    +
  • Defined in src/classes/Channel.ts:23
    • @@ -134,29 +134,29 @@

    Returns Channel

    +
  • Defined in src/classes/Channel.ts:32

    • Properties

    Private Optional #ackLimit

    #ackLimit?: number
    +
  • Defined in src/classes/Channel.ts:594

    • Private Optional #ackTimeout

    #ackTimeout?: number
    +
  • Defined in src/classes/Channel.ts:593

    • Private Readonly #collection

    #collection: ChannelCollection
    +
  • Defined in src/classes/Channel.ts:24

    • Readonly id

    id: string
    +
  • Defined in src/classes/Channel.ts:25

    • Accessors

    @@ -168,7 +168,7 @@

    Returns boolean

    +
  • Defined in src/classes/Channel.ts:112

    • animatedIconURL

    +
  • Defined in src/classes/Channel.ts:315

    • createdAt

    +
  • Defined in src/classes/Channel.ts:48

    • defaultPermissions

    +
  • Defined in src/classes/Channel.ts:217

    • description

    +
  • Defined in src/classes/Channel.ts:98

    • displayName

    +
  • Defined in src/classes/Channel.ts:87

    • icon

    +
  • Defined in src/classes/Channel.ts:105

    • iconURL

    +
  • Defined in src/classes/Channel.ts:299

    • lastMessage

    +
  • Defined in src/classes/Channel.ts:245

    • lastMessageAt

    +
  • Defined in src/classes/Channel.ts:252

    • lastMessageId

    +
  • Defined in src/classes/Channel.ts:238

    • mature

    +
  • Defined in src/classes/Channel.ts:231

    • mentions

    +
  • Defined in src/classes/Channel.ts:288

    • name

    +
  • Defined in src/classes/Channel.ts:80

    • owner

    +
  • Defined in src/classes/Channel.ts:185

    • ownerId

    +
  • Defined in src/classes/Channel.ts:178

    • path

    +
  • Defined in src/classes/Channel.ts:62

    • permission

    +
  • Defined in src/classes/Channel.ts:325

    • permissions

    +
  • Defined in src/classes/Channel.ts:210

    • recipient

    +
  • Defined in src/classes/Channel.ts:151

    • recipientIds

    +
  • Defined in src/classes/Channel.ts:135

    • recipients

    +
  • Defined in src/classes/Channel.ts:142

    • rolePermissions

    +
  • Defined in src/classes/Channel.ts:224

    • server

    +
  • Defined in src/classes/Channel.ts:201

    • serverId

    +
  • Defined in src/classes/Channel.ts:194

    • smallIconURL

    +
  • Defined in src/classes/Channel.ts:308

    • type

    +
  • Defined in src/classes/Channel.ts:55

    • typing

    +
  • Defined in src/classes/Channel.ts:126

    • typingIds

    +
  • Defined in src/classes/Channel.ts:119

    • unread

    +
  • Defined in src/classes/Channel.ts:268

    • updatedAt

    +
  • Defined in src/classes/Channel.ts:261

    • url

    +
  • Defined in src/classes/Channel.ts:73

    • user

    +
  • Defined in src/classes/Channel.ts:169

    • userId

    +
  • Defined in src/classes/Channel.ts:162

    • Methods

    @@ -523,7 +523,7 @@

    Returns Promise<void>

    +
  • Defined in src/classes/Channel.ts:602

    • addMember

    Returns Promise<undefined>

    +
  • Defined in src/classes/Channel.ts:402

    • createInvite

    +
  • Defined in src/classes/Channel.ts:587

    • delete

    Returns Promise<void>

    +
  • Defined in src/classes/Channel.ts:384

    • deleteMessages

    Returns Promise<void>

    +
  • Defined in src/classes/Channel.ts:573

    • edit

    Returns Promise<void>

    +
  • Defined in src/classes/Channel.ts:375

    • fetchMembers

    +
  • Defined in src/classes/Channel.ts:359

    • fetchMessage

    Returns Promise<Message>

    +
  • Defined in src/classes/Channel.ts:455

    • fetchMessages

    Returns Promise<Message[]>

    +
  • Defined in src/classes/Channel.ts:469

    • fetchMessagesWithUsers

    Returns Promise<{
        members: undefined | ServerMember[];
        messages: Message[];
        users: User[];
    }>

    +
  • Defined in src/classes/Channel.ts:494

    • havePermission

    Returns boolean

    +
  • Defined in src/classes/Channel.ts:334

    • orPermission

    Returns boolean

    +
  • Defined in src/classes/Channel.ts:346

    • removeMember

    Returns Promise<undefined>

    +
  • Defined in src/classes/Channel.ts:413

    • search

    Returns Promise<Message[]>

    +
  • Defined in src/classes/Channel.ts:527

    • searchWithUsers

    Returns Promise<{
        members: undefined | ServerMember[];
        messages: Message[];
        users: User[];
    }>

    +
  • Defined in src/classes/Channel.ts:546

    • sendMessage

    Returns Promise<Message>

    +
  • Defined in src/classes/Channel.ts:425

    • setPermissions

    Returns Promise<{
        _id: string;
        analytics?: boolean;
        banner?: 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;
        };
        categories?: null | {
            channels: string[];
            id: string;
            title: string;
        }[];
        channels: string[];
        default_permissions: number;
        description?: null | string;
        discoverable?: boolean;
        flags?: null | number;
        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;
        owner: string;
        roles?: {
            [key: string]: components["schemas"]["Role"];
        };
        system_messages?: null | {
            user_banned?: null | string;
            user_joined?: null | string;
            user_kicked?: null | string;
            user_left?: null | string;
        };
    }>

    +
  • Defined in src/classes/Channel.ts:651

    • startTyping

    +
  • Defined in src/classes/Channel.ts:662

    • stopTyping

    +
  • Defined in src/classes/Channel.ts:673

    • toString

    +
  • Defined in src/classes/Channel.ts:41
    • diff --git a/classes/ChannelCollection.html b/classes/ChannelCollection.html index 60d6ca1b..74f21f8d 100644 --- a/classes/ChannelCollection.html +++ b/classes/ChannelCollection.html @@ -37,7 +37,7 @@
    • ChannelCollection
    +
  • Defined in src/collections/ChannelCollection.ts:9
    • @@ -95,7 +95,7 @@

    Returns ChannelCollection

    +
  • Defined in src/collections/Collection.ts:239

    • Properties

    @@ -103,19 +103,19 @@
    #objects: ReactiveMap<string, Channel> = ...
    +
  • Defined in src/collections/Collection.ts:119

    • Private #storage

    #storage: ObjectStorage<HydratedChannel> = ...
    +
  • Defined in src/collections/Collection.ts:118

    • Readonly client

    client: Client
    +
  • Defined in src/collections/Collection.ts:233

    • Readonly getUnderlyingObject

    getUnderlyingObject: ((id: string) => HydratedChannel)
    @@ -134,13 +134,13 @@

    Returns HydratedChannel

    +
  • Defined in src/collections/Collection.ts:120

    • Readonly updateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedChannel>>
    +
  • Defined in src/collections/Collection.ts:121

    • Methods

    @@ -176,7 +176,7 @@

    Returns void

    +
  • Defined in src/collections/Collection.ts:167

    • createGroup

      @@ -199,7 +199,7 @@

    Returns Promise<Channel>

    +
  • Defined in src/collections/ChannelCollection.ts:75

    • delete

    +
  • Defined in src/collections/ChannelCollection.ts:17

    • entries

    +
  • Defined in src/collections/Collection.ts:215

    • fetch

    Returns Promise<Channel>

    +
  • Defined in src/collections/ChannelCollection.ts:28

    • filter

    +
  • Defined in src/collections/Collection.ts:77

    • find

    +
  • Defined in src/collections/Collection.ts:105

    • forEach

    +
  • Defined in src/collections/Collection.ts:224

    • get

    +
  • Defined in src/collections/Collection.ts:137

    • getOrCreate

    Returns Channel

    +
  • Defined in src/collections/ChannelCollection.ts:41

    • getOrPartial

    Returns undefined | Channel

    +
  • Defined in src/collections/ChannelCollection.ts:56

    • has

    +
  • Defined in src/collections/Collection.ts:146

    • isPartial

    +
  • Defined in src/collections/Collection.ts:183

    • keys

    +
  • Defined in src/collections/Collection.ts:199

    • map

    +
  • Defined in src/collections/Collection.ts:92

    • size

    +
  • Defined in src/collections/Collection.ts:191

    • toList

    +
  • Defined in src/collections/Collection.ts:69

    • values

    +
  • Defined in src/collections/Collection.ts:207
    • diff --git a/classes/ChannelEditSystemMessage.html b/classes/ChannelEditSystemMessage.html index 09c5515d..7c3e84dd 100644 --- a/classes/ChannelEditSystemMessage.html +++ b/classes/ChannelEditSystemMessage.html @@ -39,7 +39,7 @@ +
  • Defined in src/classes/SystemMessage.ts:142
    • @@ -86,26 +86,26 @@

    Returns ChannelEditSystemMessage

    +
  • Defined in src/classes/SystemMessage.ts:150

    • Properties

    Readonly byId

    byId: string
    +
  • Defined in src/classes/SystemMessage.ts:143

    • Protected Optional client

    client?: Client
    +
  • Defined in src/classes/SystemMessage.ts:7

    • Readonly type

    type: "text" | "user_added" | "user_remove" | "user_joined" | "user_left" | "user_kicked" | "user_banned" | "channel_renamed" | "channel_description_changed" | "channel_icon_changed" | "channel_ownership_changed"
    +
  • Defined in src/classes/SystemMessage.ts:8

    • Accessors

    @@ -117,7 +117,7 @@

    Returns undefined | User

    +
  • Defined in src/classes/SystemMessage.ts:166

    • Methods

    @@ -141,7 +141,7 @@

    Returns SystemMessage

    +
  • Defined in src/classes/SystemMessage.ts:26
    • diff --git a/classes/ChannelInvite.html b/classes/ChannelInvite.html index 9236804b..41fe65f5 100644 --- a/classes/ChannelInvite.html +++ b/classes/ChannelInvite.html @@ -38,7 +38,7 @@
  • UnknownInvite
  • ServerInvite
    • +
  • Defined in src/classes/Invite.ts:6
    • @@ -79,19 +79,19 @@

    Returns ChannelInvite

    +
  • Defined in src/classes/Invite.ts:15

    • Properties

    Protected Optional client

    client?: Client
    +
  • Defined in src/classes/Invite.ts:7

    • Readonly type

    type: "Server" | "None" | "Group"
    +
  • Defined in src/classes/Invite.ts:8

    • Methods

    @@ -116,7 +116,7 @@

    Returns ChannelInvite

    +
  • Defined in src/classes/Invite.ts:26
    • diff --git a/classes/ChannelOwnershipChangeSystemMessage.html b/classes/ChannelOwnershipChangeSystemMessage.html index db79a928..338cb60e 100644 --- a/classes/ChannelOwnershipChangeSystemMessage.html +++ b/classes/ChannelOwnershipChangeSystemMessage.html @@ -37,7 +37,7 @@
    • ChannelOwnershipChangeSystemMessage
    +
  • Defined in src/classes/SystemMessage.ts:196
    • @@ -86,7 +86,7 @@

    Returns ChannelOwnershipChangeSystemMessage

    +
  • Defined in src/classes/SystemMessage.ts:205

    • Properties

    @@ -94,23 +94,23 @@
    client?: Client
    +
  • Defined in src/classes/SystemMessage.ts:7

    • Readonly fromId

    fromId: string
    +
  • Defined in src/classes/SystemMessage.ts:197

    • Readonly toId

    toId: string
    +
  • Defined in src/classes/SystemMessage.ts:198

    • Readonly type

    type: "text" | "user_added" | "user_remove" | "user_joined" | "user_left" | "user_kicked" | "user_banned" | "channel_renamed" | "channel_description_changed" | "channel_icon_changed" | "channel_ownership_changed"
    +
  • Defined in src/classes/SystemMessage.ts:8

    • Accessors

    @@ -122,7 +122,7 @@

    Returns undefined | User

    +
  • Defined in src/classes/SystemMessage.ts:219

    • to

      @@ -132,7 +132,7 @@

    Returns undefined | User

    +
  • Defined in src/classes/SystemMessage.ts:226

    • Methods

    @@ -156,7 +156,7 @@

    Returns SystemMessage

    +
  • Defined in src/classes/SystemMessage.ts:26
    • diff --git a/classes/ChannelRenamedSystemMessage.html b/classes/ChannelRenamedSystemMessage.html index 6b73c3ff..fb910d27 100644 --- a/classes/ChannelRenamedSystemMessage.html +++ b/classes/ChannelRenamedSystemMessage.html @@ -37,7 +37,7 @@
    • ChannelRenamedSystemMessage
    +
  • Defined in src/classes/SystemMessage.ts:174
    • @@ -85,7 +85,7 @@

    Returns ChannelRenamedSystemMessage

    +
  • Defined in src/classes/SystemMessage.ts:182

    • Properties

    @@ -93,24 +93,24 @@
    byId: string
    +
  • Defined in src/classes/SystemMessage.ts:143

    • Protected Optional client

    client?: Client
    +
  • Defined in src/classes/SystemMessage.ts:7

    • Readonly name

    name: string
    +
  • Defined in src/classes/SystemMessage.ts:175

    • Readonly type

    type: "text" | "user_added" | "user_remove" | "user_joined" | "user_left" | "user_kicked" | "user_banned" | "channel_renamed" | "channel_description_changed" | "channel_icon_changed" | "channel_ownership_changed"
    +
  • Defined in src/classes/SystemMessage.ts:8

    • Accessors

    @@ -123,7 +123,7 @@

    Returns undefined | User

    +
  • Defined in src/classes/SystemMessage.ts:166

    • Methods

    @@ -147,7 +147,7 @@

    Returns SystemMessage

    +
  • Defined in src/classes/SystemMessage.ts:26
    • diff --git a/classes/ChannelUnread.html b/classes/ChannelUnread.html index 6602639f..f4a1f8b8 100644 --- a/classes/ChannelUnread.html +++ b/classes/ChannelUnread.html @@ -35,7 +35,7 @@
    • ChannelUnread
    +
  • Defined in src/classes/ChannelUnread.ts:6
    • @@ -77,19 +77,19 @@

    Returns ChannelUnread

    +
  • Defined in src/classes/ChannelUnread.ts:15

    • Properties

    Private Readonly #collection

    #collection: ChannelUnreadCollection
    +
  • Defined in src/classes/ChannelUnread.ts:7

    • Readonly id

    id: string
    +
  • Defined in src/classes/ChannelUnread.ts:8

    • Accessors

    @@ -101,7 +101,7 @@

    Returns undefined | string

    +
  • Defined in src/classes/ChannelUnread.ts:23

    • messageMentionIds

    +
  • Defined in src/classes/ChannelUnread.ts:30
    • diff --git a/classes/ChannelUnreadCollection.html b/classes/ChannelUnreadCollection.html index 0ac59cfa..9a1d2aa6 100644 --- a/classes/ChannelUnreadCollection.html +++ b/classes/ChannelUnreadCollection.html @@ -37,7 +37,7 @@
    • ChannelUnreadCollection
    +
  • Defined in src/collections/ChannelUnreadCollection.ts:10
    • @@ -94,7 +94,7 @@

    Returns ChannelUnreadCollection

    +
  • Defined in src/collections/Collection.ts:239

    • Properties

    @@ -102,19 +102,19 @@
    #objects: ReactiveMap<string, ChannelUnread> = ...
    +
  • Defined in src/collections/Collection.ts:119

    • Private #storage

    #storage: ObjectStorage<HydratedChannelUnread> = ...
    +
  • Defined in src/collections/Collection.ts:118

    • Readonly client

    client: Client
    +
  • Defined in src/collections/Collection.ts:233

    • Readonly getUnderlyingObject

    getUnderlyingObject: ((id: string) => HydratedChannelUnread)
    @@ -133,13 +133,13 @@

    Returns HydratedChannelUnread

    +
  • Defined in src/collections/Collection.ts:120

    • Readonly updateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedChannelUnread>>
    +
  • Defined in src/collections/Collection.ts:121

    • Methods

    @@ -175,7 +175,7 @@

    Returns void

    +
  • Defined in src/collections/Collection.ts:167

    • delete

    +
  • Defined in src/collections/Collection.ts:154

    • entries

    +
  • Defined in src/collections/Collection.ts:215

    • filter

    +
  • Defined in src/collections/Collection.ts:77

    • find

    +
  • Defined in src/collections/Collection.ts:105

    • forEach

    +
  • Defined in src/collections/Collection.ts:224

    • get

    +
  • Defined in src/collections/Collection.ts:137

    • getOrCreate

      @@ -371,7 +371,7 @@

    Returns ChannelUnread

    +
  • Defined in src/collections/ChannelUnreadCollection.ts:37

    • has

    +
  • Defined in src/collections/Collection.ts:146

    • isPartial

    +
  • Defined in src/collections/Collection.ts:183

    • keys

    +
  • Defined in src/collections/Collection.ts:199

    • map

    +
  • Defined in src/collections/Collection.ts:92

    • reset

    +
  • Defined in src/collections/ChannelUnreadCollection.ts:28

    • size

    +
  • Defined in src/collections/Collection.ts:191

    • sync

    +
  • Defined in src/collections/ChannelUnreadCollection.ts:17

    • toList

    +
  • Defined in src/collections/Collection.ts:69

    • values

    +
  • Defined in src/collections/Collection.ts:207
    • diff --git a/classes/ClassCollection.html b/classes/ClassCollection.html index 3856a17f..1901fe7a 100644 --- a/classes/ClassCollection.html +++ b/classes/ClassCollection.html @@ -54,7 +54,7 @@
  • SessionCollection
  • UserCollection
    • +
  • Defined in src/collections/Collection.ts:232
    • @@ -115,7 +115,7 @@

    Returns ClassCollection<T, V>

    +
  • Defined in src/collections/Collection.ts:239

    • Properties

    @@ -123,18 +123,18 @@
    #objects: ReactiveMap<string, T> = ...
    +
  • Defined in src/collections/Collection.ts:119

    • Private #storage

    #storage: ObjectStorage<V> = ...
    +
  • Defined in src/collections/Collection.ts:118

    • Readonly client

    client: Client
    +
  • Defined in src/collections/Collection.ts:233

    • Readonly getUnderlyingObject

    getUnderlyingObject: ((id: string) => V)
    @@ -153,13 +153,13 @@

    Returns V

    +
  • Defined in src/collections/Collection.ts:120

    • Readonly updateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, V>>
    +
  • Defined in src/collections/Collection.ts:121

    • Methods

    @@ -195,7 +195,7 @@

    Returns void

    +
  • Defined in src/collections/Collection.ts:167

    • delete

    +
  • Defined in src/collections/Collection.ts:154

    • entries

    +
  • Defined in src/collections/Collection.ts:215

    • filter

    +
  • Defined in src/collections/Collection.ts:77

    • find

    +
  • Defined in src/collections/Collection.ts:105

    • forEach

    +
  • Defined in src/collections/Collection.ts:224

    • get

    +
  • Defined in src/collections/Collection.ts:137

    • has

    +
  • Defined in src/collections/Collection.ts:146

    • isPartial

    +
  • Defined in src/collections/Collection.ts:183

    • keys

    +
  • Defined in src/collections/Collection.ts:199

    • map

    +
  • Defined in src/collections/Collection.ts:92

    • size

    +
  • Defined in src/collections/Collection.ts:191

    • toList

    +
  • Defined in src/collections/Collection.ts:69

    • values

    +
  • Defined in src/collections/Collection.ts:207
    • diff --git a/classes/Client.html b/classes/Client.html index 6c63ec61..30ea2afb 100644 --- a/classes/Client.html +++ b/classes/Client.html @@ -37,7 +37,7 @@
    • Client
    +
  • Defined in src/Client.ts:146
    • @@ -253,114 +253,114 @@

    Returns Client

    +
  • Defined in src/Client.ts:176

    • Properties

    Private #reconnectTimeout

    #reconnectTimeout: undefined | number
    +
  • Defined in src/Client.ts:171

    • Private #session

    #session: undefined | PrivateSession
    +
  • Defined in src/Client.ts:163

    • Private #setConnectionFailureCount

    #setConnectionFailureCount: Setter<number>
    +
  • Defined in src/Client.ts:170

    • Private #setReady

    #setReady: Setter<boolean>
    +
  • Defined in src/Client.ts:167

    • Readonly account

    account: AccountCollection
    +
  • Defined in src/Client.ts:147

    • Readonly api

    api: API
    +
  • Defined in src/Client.ts:158

    • Readonly bots

    bots: BotCollection
    +
  • Defined in src/Client.ts:148

    • Readonly channelUnreads

    channelUnreads: ChannelUnreadCollection
    +
  • Defined in src/Client.ts:150

    • Readonly channels

    channels: ChannelCollection
    +
  • Defined in src/Client.ts:149

    • configuration

    configuration: undefined | {
        app: string;
        build: {
            commit_sha: string;
            commit_timestamp: string;
            origin_url: string;
            semver: string;
            timestamp: string;
        };
        features: {
            autumn: {
                enabled: boolean;
                url: string;
            };
            captcha: {
                enabled: boolean;
                key: string;
            };
            email: boolean;
            invite_only: boolean;
            january: {
                enabled: boolean;
                url: string;
            };
            voso: {
                enabled: boolean;
                url: string;
                ws: string;
            };
        };
        revolt: string;
        vapid: string;
        ws: string;
    }
    +
  • Defined in src/Client.ts:162

    • Readonly connectionFailureCount

    connectionFailureCount: Accessor<number>
    +
  • Defined in src/Client.ts:169

    • Readonly emojis

    emojis: EmojiCollection
    +
  • Defined in src/Client.ts:151

    • Readonly events

    events: EventClient<1>
    +
  • Defined in src/Client.ts:160

    • Readonly messages

    messages: MessageCollection
    +
  • Defined in src/Client.ts:152

    • Readonly options

    options: ClientOptions
    +
  • Defined in src/Client.ts:159

    • Readonly ready

    ready: Accessor<boolean>
    +
  • Defined in src/Client.ts:166

    • Readonly serverMembers

    serverMembers: ServerMemberCollection
    +
  • Defined in src/Client.ts:154

    • Readonly servers

    servers: ServerCollection
    +
  • Defined in src/Client.ts:153

    • Readonly sessions

    sessions: SessionCollection
    +
  • Defined in src/Client.ts:155

    • user

    user: undefined | User
    +
  • Defined in src/Client.ts:164

    • Readonly users

    users: UserCollection
    +
  • Defined in src/Client.ts:156

    • Static prefixed

    prefixed: string | boolean

    Returns undefined | string

    +
  • Defined in src/Client.ts:266

    • Methods

    @@ -390,7 +390,7 @@

    Returns Promise<void>

    +
  • Defined in src/Client.ts:286

    • Private #updateHeaders

    +
  • Defined in src/Client.ts:295

    • addListener

    +
  • Defined in src/Client.ts:273

    • emit

    Returns Promise<void>

    +
  • Defined in src/Client.ts:309

    • loginBot

    Returns Promise<void>

    +
  • Defined in src/Client.ts:336

    • markdownToText

    Returns string

    +
  • Defined in src/Client.ts:348

    • off

    Returns undefined | string

    +
  • Defined in src/Client.ts:376

    • removeAllListeners

    Returns Promise<void>

    +
  • Defined in src/Client.ts:325
    • diff --git a/classes/Collection.html b/classes/Collection.html index ae0ca693..fb4f8c87 100644 --- a/classes/Collection.html +++ b/classes/Collection.html @@ -42,7 +42,7 @@ +
  • Defined in src/collections/Collection.ts:12
    • @@ -98,7 +98,7 @@

    Returns void

    +
  • Defined in src/collections/Collection.ts:31

    • Abstract entries

    +
  • Defined in src/collections/Collection.ts:55

    • filter

    Returns T[]

    +
  • Defined in src/collections/Collection.ts:77

    • find

    Returns undefined | T

    +
  • Defined in src/collections/Collection.ts:105

    • Abstract forEach

    Returns void

    +
  • Defined in src/collections/Collection.ts:61

    • Abstract get

    Returns undefined | T

    +
  • Defined in src/collections/Collection.ts:18

    • Abstract has

    Returns boolean

    +
  • Defined in src/collections/Collection.ts:25

    • Abstract keys

    +
  • Defined in src/collections/Collection.ts:43

    • map

    Returns O[]

    +
  • Defined in src/collections/Collection.ts:92

    • Abstract size

    +
  • Defined in src/collections/Collection.ts:37

    • toList

    +
  • Defined in src/collections/Collection.ts:69

    • Abstract values

    +
  • Defined in src/collections/Collection.ts:49
    • diff --git a/classes/Emoji.html b/classes/Emoji.html index fb10f061..a4809580 100644 --- a/classes/Emoji.html +++ b/classes/Emoji.html @@ -35,7 +35,7 @@
    • Emoji
    +
  • Defined in src/classes/Emoji.ts:8
    • @@ -86,19 +86,19 @@

    Returns Emoji

    +
  • Defined in src/classes/Emoji.ts:17

    • Properties

    Private Readonly #collection

    #collection: EmojiCollection
    +
  • Defined in src/classes/Emoji.ts:9

    • Readonly id

    id: string
    +
  • Defined in src/classes/Emoji.ts:10

    • Accessors

    @@ -110,7 +110,7 @@

    Returns boolean

    +
  • Defined in src/classes/Emoji.ts:63

    • createdAt

    +
  • Defined in src/classes/Emoji.ts:33

    • creator

    +
  • Defined in src/classes/Emoji.ts:47

    • mature

    +
  • Defined in src/classes/Emoji.ts:70

    • name

    +
  • Defined in src/classes/Emoji.ts:56

    • parent

    +
  • Defined in src/classes/Emoji.ts:40

    • Methods

    @@ -172,7 +172,7 @@

    Returns Promise<void>

    +
  • Defined in src/classes/Emoji.ts:77

    • toString

    +
  • Defined in src/classes/Emoji.ts:26
    • diff --git a/classes/EmojiCollection.html b/classes/EmojiCollection.html index a457ed44..7a939d22 100644 --- a/classes/EmojiCollection.html +++ b/classes/EmojiCollection.html @@ -37,7 +37,7 @@
    • EmojiCollection
    +
  • Defined in src/collections/EmojiCollection.ts:9
    • @@ -94,7 +94,7 @@

    Returns EmojiCollection

    +
  • Defined in src/collections/Collection.ts:239

    • Properties

    @@ -102,19 +102,19 @@
    #objects: ReactiveMap<string, Emoji> = ...
    +
  • Defined in src/collections/Collection.ts:119

    • Private #storage

    #storage: ObjectStorage<HydratedEmoji> = ...
    +
  • Defined in src/collections/Collection.ts:118

    • Readonly client

    client: Client
    +
  • Defined in src/collections/Collection.ts:233

    • Readonly getUnderlyingObject

    getUnderlyingObject: ((id: string) => HydratedEmoji)
    @@ -133,13 +133,13 @@

    Returns HydratedEmoji

    +
  • Defined in src/collections/Collection.ts:120

    • Readonly updateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedEmoji>>
    +
  • Defined in src/collections/Collection.ts:121

    • Methods

    @@ -175,7 +175,7 @@

    Returns void

    +
  • Defined in src/collections/Collection.ts:167

    • delete

    +
  • Defined in src/collections/Collection.ts:154

    • entries

    +
  • Defined in src/collections/Collection.ts:215

    • fetch

      @@ -225,7 +225,7 @@

    Returns Promise<Emoji>

    +
  • Defined in src/collections/EmojiCollection.ts:15

    • filter

    +
  • Defined in src/collections/Collection.ts:77

    • find

    +
  • Defined in src/collections/Collection.ts:105

    • forEach

    +
  • Defined in src/collections/Collection.ts:224

    • get

    +
  • Defined in src/collections/Collection.ts:137

    • getOrCreate

    Returns Emoji

    +
  • Defined in src/collections/EmojiCollection.ts:28

    • getOrPartial

    Returns undefined | Emoji

    +
  • Defined in src/collections/EmojiCollection.ts:43

    • has

    +
  • Defined in src/collections/Collection.ts:146

    • isPartial

    +
  • Defined in src/collections/Collection.ts:183

    • keys

    +
  • Defined in src/collections/Collection.ts:199

    • map

    +
  • Defined in src/collections/Collection.ts:92

    • size

    +
  • Defined in src/collections/Collection.ts:191

    • toList

    +
  • Defined in src/collections/Collection.ts:69

    • values

    +
  • Defined in src/collections/Collection.ts:207
    • diff --git a/classes/EventClient.html b/classes/EventClient.html index c887095c..af60804d 100644 --- a/classes/EventClient.html +++ b/classes/EventClient.html @@ -42,7 +42,7 @@
    • EventClient
    +
  • Defined in src/events/EventClient.ts:53
    • @@ -118,59 +118,59 @@ Events<T, EventProtocol<T>> >.constructor

    +
  • Defined in src/events/EventClient.ts:77

    • Properties

    Private #heartbeatIntervalReference

    #heartbeatIntervalReference: undefined | number
    +
  • Defined in src/events/EventClient.ts:68

    • Private #pongTimeoutReference

    #pongTimeoutReference: undefined | number
    +
  • Defined in src/events/EventClient.ts:69

    • Private #protocolVersion

    #protocolVersion: T
    +
  • Defined in src/events/EventClient.ts:58

    • Private #setPing

    #setPing: Setter<number>
    +
  • Defined in src/events/EventClient.ts:62

    • Private #setStateSetter

    #setStateSetter: Setter<ConnectionState>
    +
  • Defined in src/events/EventClient.ts:65

    • Private #socket

    #socket: undefined | WebSocket
    +
  • Defined in src/events/EventClient.ts:67

    • Private #transportFormat

    #transportFormat: "json" | "msgpack"
    +
  • Defined in src/events/EventClient.ts:59

    • Readonly options

    options: EventClientOptions
    +
  • Defined in src/events/EventClient.ts:56

    • Readonly ping

    ping: Accessor<number>
    +
  • Defined in src/events/EventClient.ts:61

    • Readonly state

    state: Accessor<ConnectionState>
    +
  • Defined in src/events/EventClient.ts:64

    • Static prefixed

    prefixed: string | boolean

    Returns void

    +
  • Defined in src/events/EventClient.ts:119

    • disconnect

    +
  • Defined in src/events/EventClient.ts:162

    • emit

    Returns void

    +
  • Defined in src/events/EventClient.ts:185

    • listenerCount

    Returns void

    +
  • Defined in src/events/EventClient.ts:175

    • Private setState

    Returns void

    +
  • Defined in src/events/EventClient.ts:109
    • diff --git a/classes/File.html b/classes/File.html index faac68f2..0c28ce58 100644 --- a/classes/File.html +++ b/classes/File.html @@ -35,7 +35,7 @@
    • File
    +
  • Defined in src/classes/File.ts:8
    • @@ -141,56 +141,56 @@
    Optional user_id?: null | string

    Returns File

    +
  • Defined in src/classes/File.ts:46

    • Properties

    Private #client

    #client: Client
    +
  • Defined in src/classes/File.ts:9

    • Readonly contentType

    contentType: string

    Raw content type of this file

    +
  • Defined in src/classes/File.ts:34

    • Readonly filename

    filename: string

    Original filename

    +
  • Defined in src/classes/File.ts:24

    • Readonly id

    id: string

    File Id

    +
  • Defined in src/classes/File.ts:14

    • Readonly metadata

    metadata: {
        type: "File";
    } | {
        type: "Text";
    } | {
        height: number;
        type: "Image";
        width: number;
    } | {
        height: number;
        type: "Video";
        width: number;
    } | {
        type: "Audio";
    }

    Parsed metadata of the file

    +
  • Defined in src/classes/File.ts:29

    • Readonly size

    size: number

    Size of the file (in bytes)

    +
  • Defined in src/classes/File.ts:39

    • Readonly tag

    tag: string

    File bucket

    +
  • Defined in src/classes/File.ts:19

    • Accessors

    @@ -202,7 +202,7 @@

    Returns string

    +
  • Defined in src/classes/File.ts:68

    • humanReadableSize

    +
  • Defined in src/classes/File.ts:77

    • isSpoiler

    +
  • Defined in src/classes/File.ts:90

    • url

    +
  • Defined in src/classes/File.ts:59

    • Methods

    @@ -266,7 +266,7 @@

    Returns undefined | string

    +
  • Defined in src/classes/File.ts:100
    • diff --git a/classes/ImageEmbed.html b/classes/ImageEmbed.html index 2e62deac..7d6afe45 100644 --- a/classes/ImageEmbed.html +++ b/classes/ImageEmbed.html @@ -37,7 +37,7 @@
    • ImageEmbed
    +
  • Defined in src/classes/MessageEmbed.ts:50
    • @@ -87,7 +87,7 @@

    Returns ImageEmbed

    +
  • Defined in src/classes/MessageEmbed.ts:61

    • Properties

    @@ -95,33 +95,33 @@
    client?: Client
    +
  • Defined in src/classes/MessageEmbed.ts:7

    • Readonly height

    height: number
    +
  • Defined in src/classes/MessageEmbed.ts:53

    • Readonly size

    size: "Large" | "Preview"
    +
  • Defined in src/classes/MessageEmbed.ts:54

    • Readonly type

    type: "None" | "Website" | "Image" | "Video" | "Text"
    +
  • Defined in src/classes/MessageEmbed.ts:8

    • Readonly url

    url: string
    +
  • Defined in src/classes/MessageEmbed.ts:51

    • Readonly width

    width: number
    +
  • Defined in src/classes/MessageEmbed.ts:52

    • Accessors

    @@ -133,7 +133,7 @@

    Returns undefined | string

    +
  • Defined in src/classes/MessageEmbed.ts:76

    • Methods

    @@ -159,7 +159,7 @@

    Returns MessageEmbed

    +
  • Defined in src/classes/MessageEmbed.ts:26
    • diff --git a/classes/Message.html b/classes/Message.html index 0e6ec7e7..cdeb34e8 100644 --- a/classes/Message.html +++ b/classes/Message.html @@ -35,7 +35,7 @@
    • Message
    +
  • Defined in src/classes/Message.ts:9
    • @@ -110,19 +110,19 @@

    Returns Message

    +
  • Defined in src/classes/Message.ts:18

    • Properties

    Private Readonly #collection

    #collection: MessageCollection
    +
  • Defined in src/classes/Message.ts:10

    • Readonly id

    id: string
    +
  • Defined in src/classes/Message.ts:11

    • Accessors

    @@ -134,7 +134,7 @@

    Returns undefined | string

    +
  • Defined in src/classes/Message.ts:200

    • attachments

    +
  • Defined in src/classes/Message.ts:117

    • author

    +
  • Defined in src/classes/Message.ts:94

    • authorId

    +
  • Defined in src/classes/Message.ts:87

    • avatarURL

    +
  • Defined in src/classes/Message.ts:189

    • channel

    +
  • Defined in src/classes/Message.ts:61

    • channelId

    +
  • Defined in src/classes/Message.ts:54

    • content

    +
  • Defined in src/classes/Message.ts:103

    • createdAt

    +
  • Defined in src/classes/Message.ts:26

    • editedAt

    +
  • Defined in src/classes/Message.ts:124

    • embeds

    +
  • Defined in src/classes/Message.ts:131

    • interactions

    +
  • Defined in src/classes/Message.ts:159

    • masquerade

    +
  • Defined in src/classes/Message.ts:166

    • masqueradeAvatarURL

    +
  • Defined in src/classes/Message.ts:212

    • member

    +
  • Defined in src/classes/Message.ts:77

    • mentionIds

    +
  • Defined in src/classes/Message.ts:138

    • nonce

    +
  • Defined in src/classes/Message.ts:47

    • path

    +
  • Defined in src/classes/Message.ts:33

    • reactions

    +
  • Defined in src/classes/Message.ts:152

    • replyIds

    +
  • Defined in src/classes/Message.ts:145

    • roleColour

    +
  • Defined in src/classes/Message.ts:182

    • server

    +
  • Defined in src/classes/Message.ts:70

    • systemMessage

    +
  • Defined in src/classes/Message.ts:110

    • url

    +
  • Defined in src/classes/Message.ts:40

    • username

    +
  • Defined in src/classes/Message.ts:173

    • Methods

    @@ -386,7 +386,7 @@

    Returns void

    +
  • Defined in src/classes/Message.ts:240

    • clearReactions

    +
  • Defined in src/classes/Message.ts:265

    • delete

    +
  • Defined in src/classes/Message.ts:231

    • edit

    Returns Promise<{
        _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";
        };
    }>

    +
  • Defined in src/classes/Message.ts:221

    • react

    Returns Promise<undefined>

    +
  • Defined in src/classes/Message.ts:275

    • reply

    Returns undefined | Promise<Message>

    +
  • Defined in src/classes/Message.ts:247

    • unreact

    Returns Promise<undefined>

    +
  • Defined in src/classes/Message.ts:287
    • diff --git a/classes/MessageCollection.html b/classes/MessageCollection.html index 91a05585..057b4da2 100644 --- a/classes/MessageCollection.html +++ b/classes/MessageCollection.html @@ -37,7 +37,7 @@
    • MessageCollection
    +
  • Defined in src/collections/MessageCollection.ts:9
    • @@ -95,7 +95,7 @@

    Returns MessageCollection

    +
  • Defined in src/collections/Collection.ts:239

    • Properties

    @@ -103,19 +103,19 @@
    #objects: ReactiveMap<string, Message> = ...
    +
  • Defined in src/collections/Collection.ts:119

    • Private #storage

    #storage: ObjectStorage<HydratedMessage> = ...
    +
  • Defined in src/collections/Collection.ts:118

    • Readonly client

    client: Client
    +
  • Defined in src/collections/Collection.ts:233

    • Readonly getUnderlyingObject

    getUnderlyingObject: ((id: string) => HydratedMessage)
    @@ -134,13 +134,13 @@

    Returns HydratedMessage

    +
  • Defined in src/collections/Collection.ts:120

    • Readonly updateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedMessage>>
    +
  • Defined in src/collections/Collection.ts:121

    • Methods

    @@ -176,7 +176,7 @@

    Returns void

    +
  • Defined in src/collections/Collection.ts:167

    • delete

    +
  • Defined in src/collections/Collection.ts:154

    • entries

    +
  • Defined in src/collections/Collection.ts:215

    • fetch

      @@ -230,7 +230,7 @@

    Returns Promise<Message>

    +
  • Defined in src/collections/MessageCollection.ts:19

    • filter

    +
  • Defined in src/collections/Collection.ts:77

    • find

    +
  • Defined in src/collections/Collection.ts:105

    • forEach

    +
  • Defined in src/collections/Collection.ts:224

    • get

    +
  • Defined in src/collections/Collection.ts:137

    • getOrCreate

    Returns Message

    +
  • Defined in src/collections/MessageCollection.ts:36

    • getOrPartial

    Returns undefined | Message

    +
  • Defined in src/collections/MessageCollection.ts:51

    • has

    +
  • Defined in src/collections/Collection.ts:146

    • isPartial

    +
  • Defined in src/collections/Collection.ts:183

    • keys

    +
  • Defined in src/collections/Collection.ts:199

    • map

    +
  • Defined in src/collections/Collection.ts:92

    • queryMessages

    Returns Promise<{
        _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";
        };
    }[] | {
        members?: null | {
            _id: {
                server: string;
                user: string;
            };
            avatar?: 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;
            };
            joined_at: string;
            nickname?: null | string;
            roles?: string[];
            timeout?: null | string;
        }[];
        messages: {
            _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";
            };
        }[];
        users: {
            _id: string;
            avatar?: 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;
            };
            badges?: null | number;
            bot?: null | {
                owner: string;
            };
            flags?: null | number;
            online?: null | boolean;
            privileged?: boolean;
            profile?: null | {
                background?: 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;
                };
                content?: null | string;
            };
            relations?: null | {
                _id: string;
                status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther";
            }[];
            relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther";
            status?: null | {
                presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
                text?: null | string;
            };
            username: string;
        }[];
    }>

    +
  • Defined in src/collections/MessageCollection.ts:69

    • size

    +
  • Defined in src/collections/Collection.ts:191

    • toList

    +
  • Defined in src/collections/Collection.ts:69

    • values

    +
  • Defined in src/collections/Collection.ts:207
    • diff --git a/classes/MessageEmbed.html b/classes/MessageEmbed.html index 29b9d01f..7f41c868 100644 --- a/classes/MessageEmbed.html +++ b/classes/MessageEmbed.html @@ -41,7 +41,7 @@
  • WebsiteEmbed
  • TextEmbed
    • +
  • Defined in src/classes/MessageEmbed.ts:6
    • @@ -82,19 +82,19 @@

    Returns MessageEmbed

    +
  • Defined in src/classes/MessageEmbed.ts:15

    • Properties

    Protected Optional client

    client?: Client
    +
  • Defined in src/classes/MessageEmbed.ts:7

    • Readonly type

    type: "None" | "Website" | "Image" | "Video" | "Text"
    +
  • Defined in src/classes/MessageEmbed.ts:8

    • Methods

    @@ -119,7 +119,7 @@

    Returns MessageEmbed

    +
  • Defined in src/classes/MessageEmbed.ts:26
    • diff --git a/classes/PublicBot.html b/classes/PublicBot.html index 38e908d7..7d9886c5 100644 --- a/classes/PublicBot.html +++ b/classes/PublicBot.html @@ -35,7 +35,7 @@
    • PublicBot
    +
  • Defined in src/classes/PublicBot.ts:6
    • @@ -101,34 +101,34 @@

    Returns PublicBot

    +
  • Defined in src/classes/PublicBot.ts:19

    • Properties

    Private #client

    #client: Client
    +
  • Defined in src/classes/PublicBot.ts:7

    • Optional Readonly avatar

    avatar?: File
    +
  • Defined in src/classes/PublicBot.ts:11

    • Optional Readonly description

    description?: string
    +
  • Defined in src/classes/PublicBot.ts:12

    • Readonly id

    id: string
    +
  • Defined in src/classes/PublicBot.ts:9

    • Readonly username

    username: string
    +
  • Defined in src/classes/PublicBot.ts:10

    • Methods

    @@ -147,7 +147,7 @@

    Returns void

    +
  • Defined in src/classes/PublicBot.ts:41

    • addToServer

    Returns void

    +
  • Defined in src/classes/PublicBot.ts:31
    • diff --git a/classes/PublicChannelInvite.html b/classes/PublicChannelInvite.html index 3780885d..9f443791 100644 --- a/classes/PublicChannelInvite.html +++ b/classes/PublicChannelInvite.html @@ -38,7 +38,7 @@
  • UnknownPublicInvite
  • ServerPublicInvite
    • +
  • Defined in src/classes/PublicInvite.ts:9
    • @@ -79,19 +79,19 @@

    Returns PublicChannelInvite

    +
  • Defined in src/classes/PublicInvite.ts:18

    • Properties

    Protected Optional client

    client?: Client
    +
  • Defined in src/classes/PublicInvite.ts:10

    • Readonly type

    type: "Server" | "None" | "Group"
    +
  • Defined in src/classes/PublicInvite.ts:11

    • Methods

    @@ -116,7 +116,7 @@

    Returns PublicChannelInvite

    +
  • Defined in src/classes/PublicInvite.ts:29
    • diff --git a/classes/Server.html b/classes/Server.html index bffb1ced..c9b61422 100644 --- a/classes/Server.html +++ b/classes/Server.html @@ -35,7 +35,7 @@
    • Server
    +
  • Defined in src/classes/Server.ts:27
    • @@ -128,24 +128,24 @@

    Returns Server

    +
  • Defined in src/classes/Server.ts:36

    • Properties

    Private Readonly #collection

    #collection: ServerCollection
    +
  • Defined in src/classes/Server.ts:28

    • Private #synced

    #synced: undefined | "partial" | "full"
    +
  • Defined in src/classes/Server.ts:540

    • Readonly id

    id: string
    +
  • Defined in src/classes/Server.ts:29

    • Accessors

    @@ -157,7 +157,7 @@

    Returns boolean

    +
  • Defined in src/classes/Server.ts:156

    • animatedIconURL

    +
  • Defined in src/classes/Server.ts:282

    • banner

    +
  • Defined in src/classes/Server.ts:96

    • bannerURL

    +
  • Defined in src/classes/Server.ts:289

    • categories

    +
  • Defined in src/classes/Server.ts:121

    • channelIds

    +
  • Defined in src/classes/Server.ts:103

    • channels

    +
  • Defined in src/classes/Server.ts:110

    • createdAt

    +
  • Defined in src/classes/Server.ts:52

    • defaultChannel

    +
  • Defined in src/classes/Server.ts:233

    • defaultPermissions

    +
  • Defined in src/classes/Server.ts:142

    • description

    +
  • Defined in src/classes/Server.ts:82

    • discoverable

    +
  • Defined in src/classes/Server.ts:163

    • flags

    +
  • Defined in src/classes/Server.ts:149

    • icon

    +
  • Defined in src/classes/Server.ts:89

    • iconURL

    +
  • Defined in src/classes/Server.ts:275

    • mature

    +
  • Defined in src/classes/Server.ts:170

    • member

    +
  • Defined in src/classes/Server.ts:296

    • mentions

    +
  • Defined in src/classes/Server.ts:264

    • name

    +
  • Defined in src/classes/Server.ts:75

    • orderedChannels

    +
  • Defined in src/classes/Server.ts:178

    • orderedRoles

    +
  • Defined in src/classes/Server.ts:243

    • owner

    +
  • Defined in src/classes/Server.ts:66

    • ownerId

    +
  • Defined in src/classes/Server.ts:59

    • permission

    +
  • Defined in src/classes/Server.ts:306

    • roles

    +
  • Defined in src/classes/Server.ts:135

    • systemMessages

    +
  • Defined in src/classes/Server.ts:128

    • unread

    +
  • Defined in src/classes/Server.ts:256

    • Methods

    @@ -437,7 +437,7 @@ which is smaller for higher priority roles.

    Returns Promise<void>

    +
  • Defined in src/classes/Server.ts:383

    • banUser

    Returns Promise<ServerBan>

    +
  • Defined in src/classes/Server.ts:392

    • createChannel

    Returns Promise<Channel>

    +
  • Defined in src/classes/Server.ts:340

    • createEmoji

    Returns Promise<Emoji>

    +
  • Defined in src/classes/Server.ts:612

    • createRole

    Returns Promise<{
        id: string;
        role: {
            colour?: null | string;
            hoist?: boolean;
            name: string;
            permissions: {
                a: number;
                d: number;
            };
            rank?: number;
        };
    }>

    +
  • Defined in src/classes/Server.ts:485

    • delete

    Returns Promise<void>

    +
  • Defined in src/classes/Server.ts:372

    • deleteRole

    Returns Promise<undefined>

    +
  • Defined in src/classes/Server.ts:510

    • edit

    Returns Promise<void>

    +
  • Defined in src/classes/Server.ts:353

    • editRole

    Returns Promise<{
        colour?: null | string;
        hoist?: boolean;
        name: string;
        permissions: {
            a: number;
            d: number;
        };
        rank?: number;
    }>

    +
  • Defined in src/classes/Server.ts:499

    • fetchBans

    +
  • Defined in src/classes/Server.ts:457

    • fetchEmojis

    +
  • Defined in src/classes/Server.ts:634

    • fetchInvites

    +
  • Defined in src/classes/Server.ts:443

    • fetchMember

    Returns Promise<ServerMember>

    +
  • Defined in src/classes/Server.ts:521

    • fetchMembers

    +
  • Defined in src/classes/Server.ts:592

    • havePermission

    Returns boolean

    +
  • Defined in src/classes/Server.ts:315

    • kickUser

    Returns Promise<undefined>

    +
  • Defined in src/classes/Server.ts:415

    • orPermission

    Returns boolean

    +
  • Defined in src/classes/Server.ts:327

    • resetSyncStatus

    +
  • Defined in src/classes/Server.ts:584

    • setPermissions

    Returns Promise<{
        _id: string;
        analytics?: boolean;
        banner?: 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;
        };
        categories?: null | {
            channels: string[];
            id: string;
            title: string;
        }[];
        channels: string[];
        default_permissions: number;
        description?: null | string;
        discoverable?: boolean;
        flags?: null | number;
        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;
        owner: string;
        roles?: {
            [key: string]: components["schemas"]["Role"];
        };
        system_messages?: null | {
            user_banned?: null | string;
            user_joined?: null | string;
            user_kicked?: null | string;
            user_left?: null | string;
        };
    }>

    +
  • Defined in src/classes/Server.ts:474

    • syncMembers

    Returns Promise<void>

    +
  • Defined in src/classes/Server.ts:546

    • toString

    +
  • Defined in src/classes/Server.ts:45

    • unbanUser

    Returns Promise<undefined>

    +
  • Defined in src/classes/Server.ts:432
    • diff --git a/classes/ServerBan.html b/classes/ServerBan.html index 4cd78a56..fed5f986 100644 --- a/classes/ServerBan.html +++ b/classes/ServerBan.html @@ -35,7 +35,7 @@
    • ServerBan
    +
  • Defined in src/classes/ServerBan.ts:8
    • @@ -104,14 +104,14 @@

    Returns ServerBan

    +
  • Defined in src/classes/ServerBan.ts:18

    • Properties

    Protected client

    client: Client
    +
  • Defined in src/classes/ServerBan.ts:9

    • Readonly id

    id: {
        server: string;
        user: string;
    }
    @@ -129,12 +129,12 @@

    Description

    User Id

    +
  • Defined in src/classes/ServerBan.ts:10

    • Optional Readonly reason

    reason?: string
    +
  • Defined in src/classes/ServerBan.ts:11

    • Accessors

    @@ -146,7 +146,7 @@

    Returns undefined | Server

    +
  • Defined in src/classes/ServerBan.ts:34

    • user

    +
  • Defined in src/classes/ServerBan.ts:27

    • Methods

    @@ -168,7 +168,7 @@

    Returns Promise<void>

    +
  • Defined in src/classes/ServerBan.ts:41
    • diff --git a/classes/ServerCollection.html b/classes/ServerCollection.html index 62be0343..84a2413d 100644 --- a/classes/ServerCollection.html +++ b/classes/ServerCollection.html @@ -37,7 +37,7 @@
    • ServerCollection
    +
  • Defined in src/collections/ServerCollection.ts:13
    • @@ -95,7 +95,7 @@

    Returns ServerCollection

    +
  • Defined in src/collections/Collection.ts:239

    • Properties

    @@ -103,19 +103,19 @@
    #objects: ReactiveMap<string, Server> = ...
    +
  • Defined in src/collections/Collection.ts:119

    • Private #storage

    #storage: ObjectStorage<HydratedServer> = ...
    +
  • Defined in src/collections/Collection.ts:118

    • Readonly client

    client: Client
    +
  • Defined in src/collections/Collection.ts:233

    • Readonly getUnderlyingObject

    getUnderlyingObject: ((id: string) => HydratedServer)
    @@ -134,13 +134,13 @@

    Returns HydratedServer

    +
  • Defined in src/collections/Collection.ts:120

    • Readonly updateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedServer>>
    +
  • Defined in src/collections/Collection.ts:121

    • Methods

    @@ -176,7 +176,7 @@

    Returns void

    +
  • Defined in src/collections/Collection.ts:167

    • createServer

      @@ -211,7 +211,7 @@

    Returns Promise<Server>

    +
  • Defined in src/collections/ServerCollection.ts:67

    • delete

    +
  • Defined in src/collections/Collection.ts:154

    • entries

    +
  • Defined in src/collections/Collection.ts:215

    • fetch

    Returns Promise<Server>

    +
  • Defined in src/collections/ServerCollection.ts:21

    • filter

    +
  • Defined in src/collections/Collection.ts:77

    • find

    +
  • Defined in src/collections/Collection.ts:105

    • forEach

    +
  • Defined in src/collections/Collection.ts:224

    • get

    +
  • Defined in src/collections/Collection.ts:137

    • getOrCreate

    Returns Server

    +
  • Defined in src/collections/ServerCollection.ts:34

    • getOrPartial

    Returns undefined | Server

    +
  • Defined in src/collections/ServerCollection.ts:49

    • has

    +
  • Defined in src/collections/Collection.ts:146

    • isPartial

    +
  • Defined in src/collections/Collection.ts:183

    • keys

    +
  • Defined in src/collections/Collection.ts:199

    • map

    +
  • Defined in src/collections/Collection.ts:92

    • size

    +
  • Defined in src/collections/Collection.ts:191

    • toList

    +
  • Defined in src/collections/Collection.ts:69

    • values

    +
  • Defined in src/collections/Collection.ts:207
    • diff --git a/classes/ServerInvite.html b/classes/ServerInvite.html index c424fa38..70594ddc 100644 --- a/classes/ServerInvite.html +++ b/classes/ServerInvite.html @@ -37,7 +37,7 @@
    • ServerInvite
    +
  • Defined in src/classes/Invite.ts:44
    • @@ -90,41 +90,41 @@

    Returns ServerInvite

    +
  • Defined in src/classes/Invite.ts:55

    • Properties

    Readonly channelId

    channelId: string
    +
  • Defined in src/classes/Invite.ts:48

    • Protected Optional client

    client?: Client
    +
  • Defined in src/classes/Invite.ts:7

    • Readonly creatorId

    creatorId: string
    +
  • Defined in src/classes/Invite.ts:46

    • Readonly id

    id: string
    +
  • Defined in src/classes/Invite.ts:45

    • Readonly serverId

    serverId: string
    +
  • Defined in src/classes/Invite.ts:47

    • Readonly type

    type: "Server" | "None" | "Group"
    +
  • Defined in src/classes/Invite.ts:8

    • Accessors

    @@ -136,7 +136,7 @@

    Returns undefined | Channel

    +
  • Defined in src/classes/Invite.ts:81

    • creator

      @@ -146,7 +146,7 @@

    Returns undefined | User

    +
  • Defined in src/classes/Invite.ts:67

    • server

    +
  • Defined in src/classes/Invite.ts:74

    • Methods

    @@ -168,7 +168,7 @@

    Returns Promise<void>

    +
  • Defined in src/classes/Invite.ts:88

    • Static from

    +
  • Defined in src/classes/Invite.ts:26
    • diff --git a/classes/ServerMember.html b/classes/ServerMember.html index 1bcd4f4e..de95307f 100644 --- a/classes/ServerMember.html +++ b/classes/ServerMember.html @@ -35,7 +35,7 @@
    • ServerMember
    +
  • Defined in src/classes/ServerMember.ts:26
    • @@ -109,14 +109,14 @@

    Returns ServerMember

    +
  • Defined in src/classes/ServerMember.ts:35

    • Properties

    Private Readonly #collection

    #collection: ServerMemberCollection
    +
  • Defined in src/classes/ServerMember.ts:27

    • Readonly id

    id: {
        server: string;
        user: string;
    }
    @@ -134,7 +134,7 @@

    Description

    User Id

    +
  • Defined in src/classes/ServerMember.ts:28

    • Accessors

    @@ -146,7 +146,7 @@

    Returns undefined | string

    +
  • Defined in src/classes/ServerMember.ts:201

    • avatar

    +
  • Defined in src/classes/ServerMember.ts:79

    • avatarURL

    +
  • Defined in src/classes/ServerMember.ts:192

    • hoistedRole

    +
  • Defined in src/classes/ServerMember.ts:115

    • joinedAt

    +
  • Defined in src/classes/ServerMember.ts:65

    • nickname

    +
  • Defined in src/classes/ServerMember.ts:72

    • orderedRoles

    +
  • Defined in src/classes/ServerMember.ts:100

    • ranking

    +
  • Defined in src/classes/ServerMember.ts:140

    • roleColour

    +
  • Defined in src/classes/ServerMember.ts:127

    • roles

    +
  • Defined in src/classes/ServerMember.ts:86

    • server

    +
  • Defined in src/classes/ServerMember.ts:51

    • timeout

    +
  • Defined in src/classes/ServerMember.ts:93

    • user

    +
  • Defined in src/classes/ServerMember.ts:58

    • Methods

    @@ -292,7 +292,7 @@ Smaller values are ranked as higher priority

    Returns Promise<void>

    +
  • Defined in src/classes/ServerMember.ts:223

    • edit

    Returns Promise<void>

    +
  • Defined in src/classes/ServerMember.ts:212

    • getPermissions

    Returns number

    +
  • Defined in src/classes/ServerMember.ts:158

    • hasPermission

    Returns boolean

    +
  • Defined in src/classes/ServerMember.ts:170

    • inferiorTo

    Returns boolean

    +
  • Defined in src/classes/ServerMember.ts:185

    • kick

    +
  • Defined in src/classes/ServerMember.ts:230

    • toString

    +
  • Defined in src/classes/ServerMember.ts:44
    • diff --git a/classes/ServerMemberCollection.html b/classes/ServerMemberCollection.html index dfa98191..05791752 100644 --- a/classes/ServerMemberCollection.html +++ b/classes/ServerMemberCollection.html @@ -37,7 +37,7 @@
    • ServerMemberCollection
    +
  • Defined in src/collections/ServerMemberCollection.ts:9
    • @@ -96,7 +96,7 @@

    Returns ServerMemberCollection

    +
  • Defined in src/collections/Collection.ts:239

    • Properties

    @@ -104,19 +104,19 @@
    #objects: ReactiveMap<string, ServerMember> = ...
    +
  • Defined in src/collections/Collection.ts:119

    • Private #storage

    #storage: ObjectStorage<HydratedServerMember> = ...
    +
  • Defined in src/collections/Collection.ts:118

    • Readonly client

    client: Client
    +
  • Defined in src/collections/Collection.ts:233

    • Readonly getUnderlyingObject

    getUnderlyingObject: ((id: string) => HydratedServerMember)
    @@ -135,13 +135,13 @@

    Returns HydratedServerMember

    +
  • Defined in src/collections/Collection.ts:120

    • Readonly updateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedServerMember>>
    +
  • Defined in src/collections/Collection.ts:121

    • Methods

    @@ -177,7 +177,7 @@

    Returns void

    +
  • Defined in src/collections/Collection.ts:167

    • delete

    +
  • Defined in src/collections/Collection.ts:154

    • entries

    +
  • Defined in src/collections/Collection.ts:215

    • fetch

      @@ -231,7 +231,7 @@

    Returns Promise<ServerMember>

    +
  • Defined in src/collections/ServerMemberCollection.ts:37

    • filter

    +
  • Defined in src/collections/Collection.ts:77

    • find

    +
  • Defined in src/collections/Collection.ts:105

    • forEach

    +
  • Defined in src/collections/Collection.ts:224

    • get

    +
  • Defined in src/collections/Collection.ts:137

    • getByKey

    Returns undefined | ServerMember

    +
  • Defined in src/collections/ServerMemberCollection.ts:27

    • getOrCreate

    Returns ServerMember

    +
  • Defined in src/collections/ServerMemberCollection.ts:53

    • getOrPartial

    Returns undefined | ServerMember

    +
  • Defined in src/collections/ServerMemberCollection.ts:73

    • has

    +
  • Defined in src/collections/Collection.ts:146

    • hasByKey

    Returns boolean

    +
  • Defined in src/collections/ServerMemberCollection.ts:18

    • isPartial

    +
  • Defined in src/collections/Collection.ts:183

    • keys

    +
  • Defined in src/collections/Collection.ts:199

    • map

    +
  • Defined in src/collections/Collection.ts:92

    • size

    +
  • Defined in src/collections/Collection.ts:191

    • toList

    +
  • Defined in src/collections/Collection.ts:69

    • values

    +
  • Defined in src/collections/Collection.ts:207
    • diff --git a/classes/ServerPublicInvite.html b/classes/ServerPublicInvite.html index 5050d458..ff09bff9 100644 --- a/classes/ServerPublicInvite.html +++ b/classes/ServerPublicInvite.html @@ -37,7 +37,7 @@
    • ServerPublicInvite
    +
  • Defined in src/classes/PublicInvite.ts:47
    • @@ -92,81 +92,81 @@

    Returns ServerPublicInvite

    +
  • Defined in src/classes/PublicInvite.ts:68

    • Properties

    Optional Readonly channelDescription

    channelDescription?: string
    +
  • Defined in src/classes/PublicInvite.ts:61

    • Readonly channelId

    channelId: string
    +
  • Defined in src/classes/PublicInvite.ts:59

    • Readonly channelName

    channelName: string
    +
  • Defined in src/classes/PublicInvite.ts:60

    • Protected Optional client

    client?: Client
    +
  • Defined in src/classes/PublicInvite.ts:10

    • Readonly code

    code: string
    +
  • Defined in src/classes/PublicInvite.ts:48

    • Readonly memberCount

    memberCount: number
    +
  • Defined in src/classes/PublicInvite.ts:57

    • Optional Readonly serverBanner

    serverBanner?: File
    +
  • Defined in src/classes/PublicInvite.ts:55

    • Readonly serverFlags

    serverFlags: ServerFlags
    +
  • Defined in src/classes/PublicInvite.ts:56

    • Optional Readonly serverIcon

    serverIcon?: File
    +
  • Defined in src/classes/PublicInvite.ts:54

    • Readonly serverId

    serverId: string
    +
  • Defined in src/classes/PublicInvite.ts:52

    • Readonly serverName

    serverName: string
    +
  • Defined in src/classes/PublicInvite.ts:53

    • Readonly type

    type: "Server" | "None" | "Group"
    +
  • Defined in src/classes/PublicInvite.ts:11

    • Optional Readonly userAvatar

    userAvatar?: File
    +
  • Defined in src/classes/PublicInvite.ts:50

    • Readonly userName

    userName: string
    +
  • Defined in src/classes/PublicInvite.ts:49

    • Methods

    @@ -178,7 +178,7 @@

    Returns Promise<Server>

    +
  • Defined in src/classes/PublicInvite.ts:96

    • Static from

    +
  • Defined in src/classes/PublicInvite.ts:29
    • diff --git a/classes/Session.html b/classes/Session.html index 3fdb78e8..0cef4777 100644 --- a/classes/Session.html +++ b/classes/Session.html @@ -35,7 +35,7 @@
    • Session
    +
  • Defined in src/classes/Session.ts:8
    • @@ -84,19 +84,19 @@

    Returns Session

    +
  • Defined in src/classes/Session.ts:17

    • Properties

    Private Readonly #collection

    #collection: SessionCollection
    +
  • Defined in src/classes/Session.ts:9

    • Readonly id

    id: string
    +
  • Defined in src/classes/Session.ts:10

    • Accessors

    @@ -108,7 +108,7 @@

    Returns Date

    +
  • Defined in src/classes/Session.ts:33

    • current

    +
  • Defined in src/classes/Session.ts:40

    • name

    +
  • Defined in src/classes/Session.ts:47

    • Methods

    @@ -140,7 +140,7 @@

    Returns Promise<void>

    +
  • Defined in src/classes/Session.ts:66

    • rename

    Returns Promise<void>

    +
  • Defined in src/classes/Session.ts:55

    • toString

    +
  • Defined in src/classes/Session.ts:26
    • diff --git a/classes/SessionCollection.html b/classes/SessionCollection.html index d01e4ec9..721c0854 100644 --- a/classes/SessionCollection.html +++ b/classes/SessionCollection.html @@ -37,7 +37,7 @@
    • SessionCollection
    +
  • Defined in src/collections/SessionCollection.ts:12
    • @@ -94,7 +94,7 @@

    Returns SessionCollection

    +
  • Defined in src/collections/Collection.ts:239

    • Properties

    @@ -102,19 +102,19 @@
    #objects: ReactiveMap<string, Session> = ...
    +
  • Defined in src/collections/Collection.ts:119

    • Private #storage

    #storage: ObjectStorage<HydratedSession> = ...
    +
  • Defined in src/collections/Collection.ts:118

    • Readonly client

    client: Client
    +
  • Defined in src/collections/Collection.ts:233

    • Readonly getUnderlyingObject

    getUnderlyingObject: ((id: string) => HydratedSession)
    @@ -133,13 +133,13 @@

    Returns HydratedSession

    +
  • Defined in src/collections/Collection.ts:120

    • Readonly updateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedSession>>
    +
  • Defined in src/collections/Collection.ts:121

    • Methods

    @@ -175,7 +175,7 @@

    Returns void

    +
  • Defined in src/collections/Collection.ts:167

    • delete

    +
  • Defined in src/collections/Collection.ts:154

    • deleteAll

      @@ -210,7 +210,7 @@

    Returns Promise<void>

    +
  • Defined in src/collections/SessionCollection.ts:31

    • entries

    +
  • Defined in src/collections/Collection.ts:215

    • fetch

    +
  • Defined in src/collections/SessionCollection.ts:20

    • filter

    +
  • Defined in src/collections/Collection.ts:77

    • find

    +
  • Defined in src/collections/Collection.ts:105

    • forEach

    +
  • Defined in src/collections/Collection.ts:224

    • get

    +
  • Defined in src/collections/Collection.ts:137

    • getOrCreate

    Returns Session

    +
  • Defined in src/collections/SessionCollection.ts:48

    • has

    +
  • Defined in src/collections/Collection.ts:146

    • isPartial

    +
  • Defined in src/collections/Collection.ts:183

    • keys

    +
  • Defined in src/collections/Collection.ts:199

    • map

    +
  • Defined in src/collections/Collection.ts:92

    • size

    +
  • Defined in src/collections/Collection.ts:191

    • toList

    +
  • Defined in src/collections/Collection.ts:69

    • values

    +
  • Defined in src/collections/Collection.ts:207
    • diff --git a/classes/StoreCollection.html b/classes/StoreCollection.html index ecd9addc..2dd5462f 100644 --- a/classes/StoreCollection.html +++ b/classes/StoreCollection.html @@ -46,7 +46,7 @@ +
  • Defined in src/collections/Collection.ts:117
    • @@ -99,19 +99,19 @@

    Returns StoreCollection<T, V>

    +
  • Defined in src/collections/Collection.ts:126

    • Properties

    Private #objects

    #objects: ReactiveMap<string, T> = ...
    +
  • Defined in src/collections/Collection.ts:119

    • Private #storage

    #storage: ObjectStorage<V> = ...
    +
  • Defined in src/collections/Collection.ts:118

    • Readonly getUnderlyingObject

    getUnderlyingObject: ((id: string) => V)
    @@ -129,12 +129,12 @@
    id: string

    Returns V

    +
  • Defined in src/collections/Collection.ts:120

    • Readonly updateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, V>>
    +
  • Defined in src/collections/Collection.ts:121

    • Methods

    @@ -169,7 +169,7 @@

    Returns void

    +
  • Defined in src/collections/Collection.ts:167

    • delete

    +
  • Defined in src/collections/Collection.ts:154

    • entries

    +
  • Defined in src/collections/Collection.ts:215

    • filter

    +
  • Defined in src/collections/Collection.ts:77

    • find

    +
  • Defined in src/collections/Collection.ts:105

    • forEach

    +
  • Defined in src/collections/Collection.ts:224

    • get

    +
  • Defined in src/collections/Collection.ts:137

    • has

    +
  • Defined in src/collections/Collection.ts:146

    • isPartial

    Returns boolean

    +
  • Defined in src/collections/Collection.ts:183

    • keys

    +
  • Defined in src/collections/Collection.ts:199

    • map

    +
  • Defined in src/collections/Collection.ts:92

    • size

    +
  • Defined in src/collections/Collection.ts:191

    • toList

    +
  • Defined in src/collections/Collection.ts:69

    • values

    +
  • Defined in src/collections/Collection.ts:207
    • diff --git a/classes/SystemMessage.html b/classes/SystemMessage.html index b43e3265..b0f69328 100644 --- a/classes/SystemMessage.html +++ b/classes/SystemMessage.html @@ -40,7 +40,7 @@
  • ChannelEditSystemMessage
  • ChannelOwnershipChangeSystemMessage
    • +
  • Defined in src/classes/SystemMessage.ts:6
    • @@ -81,19 +81,19 @@

    Returns SystemMessage

    +
  • Defined in src/classes/SystemMessage.ts:15

    • Properties

    Protected Optional client

    client?: Client
    +
  • Defined in src/classes/SystemMessage.ts:7

    • Readonly type

    type: "text" | "user_added" | "user_remove" | "user_joined" | "user_left" | "user_kicked" | "user_banned" | "channel_renamed" | "channel_description_changed" | "channel_icon_changed" | "channel_ownership_changed"
    +
  • Defined in src/classes/SystemMessage.ts:8

    • Methods

    @@ -116,7 +116,7 @@
    message: {
        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";
    }

    Returns SystemMessage

    +
  • Defined in src/classes/SystemMessage.ts:26
    • diff --git a/classes/TextEmbed.html b/classes/TextEmbed.html index 05c25045..5cf23ff1 100644 --- a/classes/TextEmbed.html +++ b/classes/TextEmbed.html @@ -37,7 +37,7 @@
    • TextEmbed
    +
  • Defined in src/classes/MessageEmbed.ts:199
    • @@ -89,7 +89,7 @@

    Returns TextEmbed

    +
  • Defined in src/classes/MessageEmbed.ts:212

    • Properties

    @@ -97,43 +97,43 @@
    client?: Client
    +
  • Defined in src/classes/MessageEmbed.ts:7

    • Optional Readonly colour

    colour?: string
    +
  • Defined in src/classes/MessageEmbed.ts:205

    • Optional Readonly description

    description?: string
    +
  • Defined in src/classes/MessageEmbed.ts:203

    • Optional Readonly iconUrl

    iconUrl?: string
    +
  • Defined in src/classes/MessageEmbed.ts:200

    • Optional Readonly media

    media?: File
    +
  • Defined in src/classes/MessageEmbed.ts:204

    • Optional Readonly title

    title?: string
    +
  • Defined in src/classes/MessageEmbed.ts:202

    • Readonly type

    type: "None" | "Website" | "Image" | "Video" | "Text"
    +
  • Defined in src/classes/MessageEmbed.ts:8

    • Optional Readonly url

    url?: string
    +
  • Defined in src/classes/MessageEmbed.ts:201

    • Accessors

    @@ -145,7 +145,7 @@

    Returns undefined | string

    +
  • Defined in src/classes/MessageEmbed.ts:229

    • Methods

    @@ -171,7 +171,7 @@

    Returns MessageEmbed

    +
  • Defined in src/classes/MessageEmbed.ts:26
    • diff --git a/classes/TextSystemMessage.html b/classes/TextSystemMessage.html index adbf1694..48aada37 100644 --- a/classes/TextSystemMessage.html +++ b/classes/TextSystemMessage.html @@ -37,7 +37,7 @@
    • TextSystemMessage
    +
  • Defined in src/classes/SystemMessage.ts:57
    • @@ -80,7 +80,7 @@

    Returns TextSystemMessage

    +
  • Defined in src/classes/SystemMessage.ts:65

    • Properties

    @@ -88,18 +88,18 @@
    client?: Client
    +
  • Defined in src/classes/SystemMessage.ts:7

    • Readonly content

    content: string
    +
  • Defined in src/classes/SystemMessage.ts:58

    • Readonly type

    type: "text" | "user_added" | "user_remove" | "user_joined" | "user_left" | "user_kicked" | "user_banned" | "channel_renamed" | "channel_description_changed" | "channel_icon_changed" | "channel_ownership_changed"
    +
  • Defined in src/classes/SystemMessage.ts:8

    • Methods

    @@ -123,7 +123,7 @@

    Returns SystemMessage

    +
  • Defined in src/classes/SystemMessage.ts:26
    • diff --git a/classes/UnknownEmbed.html b/classes/UnknownEmbed.html index eed73d10..8f0b6fbf 100644 --- a/classes/UnknownEmbed.html +++ b/classes/UnknownEmbed.html @@ -37,7 +37,7 @@
    • UnknownEmbed
    +
  • Defined in src/classes/MessageEmbed.ts:45
    • @@ -79,7 +79,7 @@

    Returns UnknownEmbed

    +
  • Defined in src/classes/MessageEmbed.ts:15

    • Properties

    @@ -87,13 +87,13 @@
    client?: Client
    +
  • Defined in src/classes/MessageEmbed.ts:7

    • Readonly type

    type: "None" | "Website" | "Image" | "Video" | "Text"
    +
  • Defined in src/classes/MessageEmbed.ts:8

    • Methods

    @@ -119,7 +119,7 @@

    Returns MessageEmbed

    +
  • Defined in src/classes/MessageEmbed.ts:26
    • diff --git a/classes/UnknownInvite.html b/classes/UnknownInvite.html index 8b75a89d..fd1e952b 100644 --- a/classes/UnknownInvite.html +++ b/classes/UnknownInvite.html @@ -37,7 +37,7 @@
    • UnknownInvite
    +
  • Defined in src/classes/Invite.ts:39
    • @@ -79,7 +79,7 @@

    Returns UnknownInvite

    +
  • Defined in src/classes/Invite.ts:15

    • Properties

    @@ -87,13 +87,13 @@
    client?: Client
    +
  • Defined in src/classes/Invite.ts:7

    • Readonly type

    type: "Server" | "None" | "Group"
    +
  • Defined in src/classes/Invite.ts:8

    • Methods

    @@ -119,7 +119,7 @@

    Returns ChannelInvite

    +
  • Defined in src/classes/Invite.ts:26
    • diff --git a/classes/UnknownPublicInvite.html b/classes/UnknownPublicInvite.html index b2ca4e1f..a3d3a8ac 100644 --- a/classes/UnknownPublicInvite.html +++ b/classes/UnknownPublicInvite.html @@ -37,7 +37,7 @@
    • UnknownPublicInvite
    +
  • Defined in src/classes/PublicInvite.ts:42
    • @@ -79,7 +79,7 @@

    Returns UnknownPublicInvite

    +
  • Defined in src/classes/PublicInvite.ts:18

    • Properties

    @@ -87,13 +87,13 @@
    client?: Client
    +
  • Defined in src/classes/PublicInvite.ts:10

    • Readonly type

    type: "Server" | "None" | "Group"
    +
  • Defined in src/classes/PublicInvite.ts:11

    • Methods

    @@ -119,7 +119,7 @@

    Returns PublicChannelInvite

    +
  • Defined in src/classes/PublicInvite.ts:29
    • diff --git a/classes/User.html b/classes/User.html index f34b48a8..cf58aece 100644 --- a/classes/User.html +++ b/classes/User.html @@ -35,7 +35,7 @@
    • User
    +
  • Defined in src/classes/User.ts:10
    • @@ -104,19 +104,19 @@

    Returns User

    +
  • Defined in src/classes/User.ts:19

    • Properties

    Private Readonly #collection

    #collection: UserCollection
    +
  • Defined in src/classes/User.ts:11

    • Readonly id

    id: string
    +
  • Defined in src/classes/User.ts:12

    • Accessors

    @@ -128,7 +128,7 @@

    Returns string

    +
  • Defined in src/classes/User.ts:123

    • avatar

    +
  • Defined in src/classes/User.ts:49

    • avatarURL

    +
  • Defined in src/classes/User.ts:114

    • badges

    +
  • Defined in src/classes/User.ts:56

    • bot

    +
  • Defined in src/classes/User.ts:98

    • createdAt

    +
  • Defined in src/classes/User.ts:35

    • defaultAvatarURL

    +
  • Defined in src/classes/User.ts:105

    • flags

    +
  • Defined in src/classes/User.ts:91

    • online

    +
  • Defined in src/classes/User.ts:77

    • permission

    +
  • Defined in src/classes/User.ts:152

    • presence

    +
  • Defined in src/classes/User.ts:133

    • privileged

    +
  • Defined in src/classes/User.ts:84

    • relationship

    +
  • Defined in src/classes/User.ts:70

    • status

    +
  • Defined in src/classes/User.ts:63

    • username

    +
  • Defined in src/classes/User.ts:42

    • Methods

    @@ -280,7 +280,7 @@

    Returns Promise<User>

    +
  • Defined in src/classes/User.ts:242

    • blockUser

    +
  • Defined in src/classes/User.ts:260

    • changeUsername

    Returns Promise<{
        _id: string;
        avatar?: 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;
        };
        badges?: null | number;
        bot?: null | {
            owner: string;
        };
        flags?: null | number;
        online?: null | boolean;
        privileged?: boolean;
        profile?: null | {
            background?: 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;
            };
            content?: null | string;
        };
        relations?: null | {
            _id: string;
            status: "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther";
        }[];
        relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther";
        status?: null | {
            presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
            text?: null | string;
        };
        username: string;
    }>

    +
  • Defined in src/classes/User.ts:204

    • edit

    Returns Promise<void>

    +
  • Defined in src/classes/User.ts:190

    • fetchMutual

    +
  • Defined in src/classes/User.ts:285

    • fetchProfile

    +
  • Defined in src/classes/User.ts:275

    • openDM

    +
  • Defined in src/classes/User.ts:215

    • removeFriend

    +
  • Defined in src/classes/User.ts:253

    • statusMessage

    Returns undefined | string

    +
  • Defined in src/classes/User.ts:142

    • toString

    +
  • Defined in src/classes/User.ts:28

    • unblockUser

    +
  • Defined in src/classes/User.ts:267
    • diff --git a/classes/UserCollection.html b/classes/UserCollection.html index a91eeeb2..355c1b08 100644 --- a/classes/UserCollection.html +++ b/classes/UserCollection.html @@ -37,7 +37,7 @@
    • UserCollection
    +
  • Defined in src/collections/UserCollection.ts:9
    • @@ -92,7 +92,7 @@

    Returns UserCollection

    +
  • Defined in src/collections/UserCollection.ts:13

    • Properties

    @@ -100,19 +100,19 @@
    #objects: ReactiveMap<string, User> = ...
    +
  • Defined in src/collections/Collection.ts:119

    • Private #storage

    #storage: ObjectStorage<HydratedUser> = ...
    +
  • Defined in src/collections/Collection.ts:118

    • Readonly client

    client: Client
    +
  • Defined in src/collections/Collection.ts:233

    • Readonly getUnderlyingObject

    getUnderlyingObject: ((id: string) => HydratedUser)
    @@ -131,13 +131,13 @@

    Returns HydratedUser

    +
  • Defined in src/collections/Collection.ts:120

    • Readonly updateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedUser>>
    +
  • Defined in src/collections/Collection.ts:121

    • Methods

    @@ -173,7 +173,7 @@

    Returns void

    +
  • Defined in src/collections/Collection.ts:167

    • delete

    +
  • Defined in src/collections/Collection.ts:154

    • entries

    +
  • Defined in src/collections/Collection.ts:215

    • fetch

      @@ -223,7 +223,7 @@

    Returns Promise<User>

    +
  • Defined in src/collections/UserCollection.ts:28

    • filter

    +
  • Defined in src/collections/Collection.ts:77

    • find

    +
  • Defined in src/collections/Collection.ts:105

    • forEach

    +
  • Defined in src/collections/Collection.ts:224

    • get

    +
  • Defined in src/collections/Collection.ts:137

    • getOrCreate

    Returns User

    +
  • Defined in src/collections/UserCollection.ts:41

    • getOrPartial

    Returns undefined | User

    +
  • Defined in src/collections/UserCollection.ts:55

    • has

    +
  • Defined in src/collections/Collection.ts:146

    • isPartial

    +
  • Defined in src/collections/Collection.ts:183

    • keys

    +
  • Defined in src/collections/Collection.ts:199

    • map

    +
  • Defined in src/collections/Collection.ts:92

    • size

    +
  • Defined in src/collections/Collection.ts:191

    • toList

    +
  • Defined in src/collections/Collection.ts:69

    • values

    +
  • Defined in src/collections/Collection.ts:207
    • diff --git a/classes/UserModeratedSystemMessage.html b/classes/UserModeratedSystemMessage.html index 1ae2442d..3ae0b2b4 100644 --- a/classes/UserModeratedSystemMessage.html +++ b/classes/UserModeratedSystemMessage.html @@ -37,7 +37,7 @@
    • UserModeratedSystemMessage
    +
  • Defined in src/classes/SystemMessage.ts:112
    • @@ -86,32 +86,32 @@

    Returns UserModeratedSystemMessage

    +
  • Defined in src/classes/SystemMessage.ts:120

    • Properties

    Readonly byId

    byId: string
    +
  • Defined in src/classes/SystemMessage.ts:113

    • Protected Optional client

    client?: Client
    +
  • Defined in src/classes/SystemMessage.ts:7

    • Readonly type

    type: "text" | "user_added" | "user_remove" | "user_joined" | "user_left" | "user_kicked" | "user_banned" | "channel_renamed" | "channel_description_changed" | "channel_icon_changed" | "channel_ownership_changed"
    +
  • Defined in src/classes/SystemMessage.ts:8

    • Readonly userId

    userId: string
    +
  • Defined in src/classes/SystemMessage.ts:78

    • Accessors

    @@ -123,7 +123,7 @@

    Returns undefined | User

    +
  • Defined in src/classes/SystemMessage.ts:133

    • user

    +
  • Defined in src/classes/SystemMessage.ts:104

    • Methods

    @@ -158,7 +158,7 @@

    Returns SystemMessage

    +
  • Defined in src/classes/SystemMessage.ts:26
    • diff --git a/classes/UserSystemMessage.html b/classes/UserSystemMessage.html index 4662eb4b..dcbc146d 100644 --- a/classes/UserSystemMessage.html +++ b/classes/UserSystemMessage.html @@ -39,7 +39,7 @@ +
  • Defined in src/classes/SystemMessage.ts:77
    • @@ -86,7 +86,7 @@

    Returns UserSystemMessage

    +
  • Defined in src/classes/SystemMessage.ts:85

    • Properties

    @@ -94,18 +94,18 @@
    client?: Client
    +
  • Defined in src/classes/SystemMessage.ts:7

    • Readonly type

    type: "text" | "user_added" | "user_remove" | "user_joined" | "user_left" | "user_kicked" | "user_banned" | "channel_renamed" | "channel_description_changed" | "channel_icon_changed" | "channel_ownership_changed"
    +
  • Defined in src/classes/SystemMessage.ts:8

    • Readonly userId

    userId: string
    +
  • Defined in src/classes/SystemMessage.ts:78

    • Accessors

    @@ -117,7 +117,7 @@

    Returns undefined | User

    +
  • Defined in src/classes/SystemMessage.ts:104

    • Methods

    @@ -141,7 +141,7 @@

    Returns SystemMessage

    +
  • Defined in src/classes/SystemMessage.ts:26
    • diff --git a/classes/VideoEmbed.html b/classes/VideoEmbed.html index a4ae1a79..afe57e00 100644 --- a/classes/VideoEmbed.html +++ b/classes/VideoEmbed.html @@ -37,7 +37,7 @@
    • VideoEmbed
    +
  • Defined in src/classes/MessageEmbed.ts:84
    • @@ -86,7 +86,7 @@

    Returns VideoEmbed

    +
  • Defined in src/classes/MessageEmbed.ts:94

    • Properties

    @@ -94,28 +94,28 @@
    client?: Client
    +
  • Defined in src/classes/MessageEmbed.ts:7

    • Readonly height

    height: number
    +
  • Defined in src/classes/MessageEmbed.ts:87

    • Readonly type

    type: "None" | "Website" | "Image" | "Video" | "Text"
    +
  • Defined in src/classes/MessageEmbed.ts:8

    • Readonly url

    url: string
    +
  • Defined in src/classes/MessageEmbed.ts:85

    • Readonly width

    width: number
    +
  • Defined in src/classes/MessageEmbed.ts:86

    • Accessors

    @@ -127,7 +127,7 @@

    Returns undefined | string

    +
  • Defined in src/classes/MessageEmbed.ts:108

    • Methods

    @@ -153,7 +153,7 @@

    Returns MessageEmbed

    +
  • Defined in src/classes/MessageEmbed.ts:26
    • diff --git a/classes/WebsiteEmbed.html b/classes/WebsiteEmbed.html index 87ebcc8f..799862cf 100644 --- a/classes/WebsiteEmbed.html +++ b/classes/WebsiteEmbed.html @@ -37,7 +37,7 @@
    • WebsiteEmbed
    +
  • Defined in src/classes/MessageEmbed.ts:116
    • @@ -94,7 +94,7 @@

    Returns WebsiteEmbed

    +
  • Defined in src/classes/MessageEmbed.ts:133

    • Properties

    @@ -102,63 +102,63 @@
    client?: Client
    +
  • Defined in src/classes/MessageEmbed.ts:7

    • Optional Readonly colour

    colour?: string
    +
  • Defined in src/classes/MessageEmbed.ts:126

    • Optional Readonly description

    description?: string
    +
  • Defined in src/classes/MessageEmbed.ts:121

    • Optional Readonly iconUrl

    iconUrl?: string
    +
  • Defined in src/classes/MessageEmbed.ts:125

    • Optional Readonly image

    image?: ImageEmbed
    +
  • Defined in src/classes/MessageEmbed.ts:122

    • Optional Readonly originalUrl

    originalUrl?: string
    +
  • Defined in src/classes/MessageEmbed.ts:118

    • Optional Readonly siteName

    siteName?: string
    +
  • Defined in src/classes/MessageEmbed.ts:124

    • Optional Readonly specialContent

    specialContent?: {
        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";
    }
    +
  • Defined in src/classes/MessageEmbed.ts:119

    • Optional Readonly title

    title?: string
    +
  • Defined in src/classes/MessageEmbed.ts:120

    • Readonly type

    type: "None" | "Website" | "Image" | "Video" | "Text"
    +
  • Defined in src/classes/MessageEmbed.ts:8

    • Optional Readonly url

    url?: string
    +
  • Defined in src/classes/MessageEmbed.ts:117

    • Optional Readonly video

    video?: VideoEmbed
    +
  • Defined in src/classes/MessageEmbed.ts:123

    • Accessors

    @@ -170,7 +170,7 @@

    Returns undefined | string

    +
  • Defined in src/classes/MessageEmbed.ts:161

    • proxiedIconURL

      @@ -180,7 +180,7 @@

    Returns undefined | string

    +
  • Defined in src/classes/MessageEmbed.ts:154

    • Methods

    @@ -206,7 +206,7 @@

    Returns MessageEmbed

    +
  • Defined in src/classes/MessageEmbed.ts:26
    • diff --git a/enums/BotFlags.html b/enums/BotFlags.html index 93361e2d..c6389034 100644 --- a/enums/BotFlags.html +++ b/enums/BotFlags.html @@ -31,7 +31,7 @@

    Flags attributed to users

    +
  • Defined in src/hydration/bot.ts:44
    • diff --git a/enums/ConnectionState.html b/enums/ConnectionState.html index f886fef0..20750afc 100644 --- a/enums/ConnectionState.html +++ b/enums/ConnectionState.html @@ -31,7 +31,7 @@

    All possible event client states.

    +
  • Defined in src/events/EventClient.ts:11
    • @@ -50,22 +50,22 @@

    Connected

    Connected: 2
    +
  • Defined in src/events/EventClient.ts:14

    • Connecting

    Connecting: 1
    +
  • Defined in src/events/EventClient.ts:13

    • Disconnected

    Disconnected: 3
    +
  • Defined in src/events/EventClient.ts:15

    • Idle

    Idle: 0
    +
  • Defined in src/events/EventClient.ts:12
    • diff --git a/enums/ServerFlags.html b/enums/ServerFlags.html index 1acba5de..33d8b182 100644 --- a/enums/ServerFlags.html +++ b/enums/ServerFlags.html @@ -31,7 +31,7 @@

    Flags attributed to servers

    +
  • Defined in src/hydration/server.ts:74
    • @@ -48,12 +48,12 @@

    Official

    Official: 1
    +
  • Defined in src/hydration/server.ts:75

    • Verified

    Verified: 2
    +
  • Defined in src/hydration/server.ts:76
    • diff --git a/enums/UserBadges.html b/enums/UserBadges.html index 6120396b..58e5adaa 100644 --- a/enums/UserBadges.html +++ b/enums/UserBadges.html @@ -31,7 +31,7 @@

    Badges available to users

    +
  • Defined in src/hydration/user.ts:55
    • @@ -57,57 +57,57 @@

    ActiveSupporter

    ActiveSupporter: 64
    +
  • Defined in src/hydration/user.ts:62

    • Developer

    Developer: 1
    +
  • Defined in src/hydration/user.ts:56

    • EarlyAdopter

    EarlyAdopter: 256
    +
  • Defined in src/hydration/user.ts:64

    • Founder

    Founder: 16
    +
  • Defined in src/hydration/user.ts:60

    • Paw

    Paw: 128
    +
  • Defined in src/hydration/user.ts:63

    • PlatformModeration

    PlatformModeration: 32
    +
  • Defined in src/hydration/user.ts:61

    • ReservedRelevantJokeBadge1

    ReservedRelevantJokeBadge1: 512
    +
  • Defined in src/hydration/user.ts:65

    • ReservedRelevantJokeBadge2

    ReservedRelevantJokeBadge2: 1024
    +
  • Defined in src/hydration/user.ts:66

    • ResponsibleDisclosure

    ResponsibleDisclosure: 8
    +
  • Defined in src/hydration/user.ts:59

    • Supporter

    Supporter: 4
    +
  • Defined in src/hydration/user.ts:58

    • Translator

    Translator: 2
    +
  • Defined in src/hydration/user.ts:57
    • diff --git a/enums/UserFlags.html b/enums/UserFlags.html index 4dfc0923..d540c30f 100644 --- a/enums/UserFlags.html +++ b/enums/UserFlags.html @@ -31,7 +31,7 @@

    Flags attributed to users

    +
  • Defined in src/hydration/user.ts:72
    • @@ -49,17 +49,17 @@

    Banned

    Banned: 4
    +
  • Defined in src/hydration/user.ts:75

    • Deleted

    Deleted: 2
    +
  • Defined in src/hydration/user.ts:74

    • Suspended

    Suspended: 1
    +
  • Defined in src/hydration/user.ts:73
    • diff --git a/types/ClientOptions.html b/types/ClientOptions.html index 9d56e001..66601e63 100644 --- a/types/ClientOptions.html +++ b/types/ClientOptions.html @@ -31,7 +31,7 @@

    Client options object

    +
  • Defined in src/Client.ts:95
    • diff --git a/types/PrivateSession.html b/types/PrivateSession.html index d32152fa..79eac1f2 100644 --- a/types/PrivateSession.html +++ b/types/PrivateSession.html @@ -29,7 +29,7 @@

    Type alias PrivateSession

    PrivateSession: {
        _id: string;
        token: string;
        user_id: string;
    } | string
    +
  • Defined in src/Client.ts:36
    • diff --git a/variables/RE_CHANNELS.html b/variables/RE_CHANNELS.html index 43cb2005..3a181a56 100644 --- a/variables/RE_CHANNELS.html +++ b/variables/RE_CHANNELS.html @@ -31,7 +31,7 @@

    Regular expression for channels.

    +
  • Defined in src/lib/regex.ts:9
    • diff --git a/variables/RE_MENTIONS.html b/variables/RE_MENTIONS.html index 832d6e7d..2ce5cee5 100644 --- a/variables/RE_MENTIONS.html +++ b/variables/RE_MENTIONS.html @@ -31,7 +31,7 @@

    Regular expression for mentions.

    +
  • Defined in src/lib/regex.ts:4
    • diff --git a/variables/RE_SPOILER.html b/variables/RE_SPOILER.html index 47482702..6ec19556 100644 --- a/variables/RE_SPOILER.html +++ b/variables/RE_SPOILER.html @@ -31,7 +31,7 @@

    Regular expression for spoilers.

    +
  • Defined in src/lib/regex.ts:14