Class ServerManager

Hierarchy

BaseManager<Server>
- ServerManager

Index

Constructors

Properties

Methods

[iterator] clear construct delete entries fetch filter find fireUpdate forEach get has items keys map offUpdate onUpdate set sort values

Constructors

constructor

new ServerManager(client: Client): ServerManager
Parameters
- client: Client
Returns ServerManager
Overrides BaseManager<Server>.constructor
- Defined in core/src/managers/ServerManager.ts:7

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Private` client

client: Client

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Methods

[iterator]

[iterator](): IterableIterator<[string, Server]>
Returns an iterable of entries in the map.

Returns IterableIterator<[string, Server]>
Inherited from BaseManager.__@iterator@11
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

clear

clear(): void
Returns void
Inherited from BaseManager.clear
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:21

construct

construct(data: {
    _id: string;
    analytics?: boolean;
    banner?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    categories?: {
        channels: string[];
        id: string;
        title: string;
    }[];
    channels: string[];
    default_permissions: number;
    description?: string;
    discoverable?: boolean;
    flags?: number;
    icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    name: string;
    nsfw?: boolean;
    owner: string;
    roles?: {
        [key: string]: components["schemas"]["Role"];
    };
    system_messages?: {
        user_banned?: string;
        user_joined?: string;
        user_kicked?: string;
        user_left?: string;
    };
}): Server
Parameters
- data: {
      _id: string;
      analytics?: boolean;
      banner?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      categories?: {
          channels: string[];
          id: string;
          title: string;
      }[];
      channels: string[];
      default_permissions: number;
      description?: string;
      discoverable?: boolean;
      flags?: number;
      icon?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      name: string;
      nsfw?: boolean;
      owner: string;
      roles?: {
          [key: string]: components["schemas"]["Role"];
      };
      system_messages?: {
          user_banned?: string;
          user_joined?: string;
          user_kicked?: string;
          user_left?: string;
      };
  }
  - _id: string
    
    Description
    Unique Id
  - Optional analytics?: boolean
    
    Description
    Whether to enable analytics
  - Optional banner?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    }
    
    Description
    Banner attachment
    - _id: string
      
      Description
      Unique Id
    - content_type: string
      
      Description
      Raw content type of this file
    - Optional deleted?: boolean
      
      Description
      Whether this file was deleted
    - filename: string
      
      Description
      Original filename
    - Optional message_id?: string
    - metadata: {
          type: "File";
      } | {
          type: "Text";
      } | {
          height: number;
          type: "Image";
          width: number;
      } | {
          height: number;
          type: "Video";
          width: number;
      } | {
          type: "Audio";
      }
      
      Description
      Parsed metadata of this file
    - Optional object_id?: string
      
      Description
      Id of the object this file is associated with
    - Optional reported?: boolean
      
      Description
      Whether this file was reported
    - Optional server_id?: string
    - size: number
      
      Format: int
      
      Description
      Size of this file (in bytes)
    - tag: string
      
      Description
      Tag / bucket this file was uploaded to
    - Optional user_id?: string
  - Optional categories?: {
        channels: string[];
        id: string;
        title: string;
    }[]
    
    Description
    Categories for this server
  - channels: string[]
    
    Description
    Channels within this server
  - default_permissions: number
    
    Format: int64
    
    Description
    Default set of server and channel permissions
  - Optional description?: string
    
    Description
    Description for the server
  - Optional discoverable?: boolean
    
    Description
    Whether this server should be publicly discoverable
  - Optional flags?: number
    
    Format: int32
    
    Description
    Bitfield of server flags
  - Optional icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    }
    
    Description
    Icon attachment
    - _id: string
      
      Description
      Unique Id
    - content_type: string
      
      Description
      Raw content type of this file
    - Optional deleted?: boolean
      
      Description
      Whether this file was deleted
    - filename: string
      
      Description
      Original filename
    - Optional message_id?: string
    - metadata: {
          type: "File";
      } | {
          type: "Text";
      } | {
          height: number;
          type: "Image";
          width: number;
      } | {
          height: number;
          type: "Video";
          width: number;
      } | {
          type: "Audio";
      }
      
      Description
      Parsed metadata of this file
    - Optional object_id?: string
      
      Description
      Id of the object this file is associated with
    - Optional reported?: boolean
      
      Description
      Whether this file was reported
    - Optional server_id?: string
    - size: number
      
      Format: int
      
      Description
      Size of this file (in bytes)
    - tag: string
      
      Description
      Tag / bucket this file was uploaded to
    - Optional user_id?: string
  - name: string
    
    Description
    Name of the server
  - Optional nsfw?: boolean
    
    Description
    Whether this server is flagged as not safe for work
  - owner: string
    
    Description
    User id of the owner
  - Optional roles?: {
    [key: string]: components["schemas"]["Role"];
    }
    
    Description
    Roles for this server
    - [key: string]: components["schemas"]["Role"]
  - Optional system_messages?: {
        user_banned?: string;
        user_joined?: string;
        user_kicked?: string;
        user_left?: string;
    }
    
    Description
    Configuration for sending system event messages
    - Optional user_banned?: string
      
      Description
      ID of channel to send user banned messages in
    - Optional user_joined?: string
      
      Description
      ID of channel to send user join messages in
    - Optional user_kicked?: string
      
      Description
      ID of channel to send user kicked messages in
    - Optional user_left?: string
      
      Description
      ID of channel to send user left messages in
Returns Server
- Defined in core/src/managers/ServerManager.ts:11

delete

delete(key: string): boolean
Parameters
- key: string
Returns boolean
Inherited from BaseManager.delete
- Defined in core/src/managers/BaseManager.ts:14

entries

entries(): IterableIterator<[string, Server]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[string, Server]>
Inherited from BaseManager.entries
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

fetch

fetch(id: string, data?: {
    _id: string;
    analytics?: boolean;
    banner?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    categories?: {
        channels: string[];
        id: string;
        title: string;
    }[];
    channels: string[];
    default_permissions: number;
    description?: string;
    discoverable?: boolean;
    flags?: number;
    icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    name: string;
    nsfw?: boolean;
    owner: string;
    roles?: {
        [key: string]: components["schemas"]["Role"];
    };
    system_messages?: {
        user_banned?: string;
        user_joined?: string;
        user_kicked?: string;
        user_left?: string;
    };
}, channels?: ({
    _id: string;
    channel_type: "SavedMessages";
    user: string;
} | {
    _id: string;
    active: boolean;
    channel_type: "DirectMessage";
    last_message_id?: string;
    recipients: string[];
} | {
    _id: string;
    channel_type: "Group";
    description?: string;
    icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    last_message_id?: string;
    name: string;
    nsfw?: boolean;
    owner: string;
    permissions?: number;
    recipients: string[];
} | {
    _id: string;
    channel_type: "TextChannel";
    default_permissions?: {
        a: number;
        d: number;
    };
    description?: string;
    icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    last_message_id?: string;
    name: string;
    nsfw?: boolean;
    role_permissions?: {
        [key: string]: components["schemas"]["OverrideField"];
    };
    server: string;
} | {
    _id: string;
    channel_type: "VoiceChannel";
    default_permissions?: {
        a: number;
        d: number;
    };
    description?: string;
    icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    name: string;
    nsfw?: boolean;
    role_permissions?: {
        [key: string]: components["schemas"]["OverrideField"];
    };
    server: string;
})[]): Promise<Server>
Parameters
- id: string
- Optional data: {
      _id: string;
      analytics?: boolean;
      banner?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      categories?: {
          channels: string[];
          id: string;
          title: string;
      }[];
      channels: string[];
      default_permissions: number;
      description?: string;
      discoverable?: boolean;
      flags?: number;
      icon?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      name: string;
      nsfw?: boolean;
      owner: string;
      roles?: {
          [key: string]: components["schemas"]["Role"];
      };
      system_messages?: {
          user_banned?: string;
          user_joined?: string;
          user_kicked?: string;
          user_left?: string;
      };
  }
  - _id: string
    
    Description
    Unique Id
  - Optional analytics?: boolean
    
    Description
    Whether to enable analytics
  - Optional banner?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    }
    
    Description
    Banner attachment
    - _id: string
      
      Description
      Unique Id
    - content_type: string
      
      Description
      Raw content type of this file
    - Optional deleted?: boolean
      
      Description
      Whether this file was deleted
    - filename: string
      
      Description
      Original filename
    - Optional message_id?: string
    - metadata: {
          type: "File";
      } | {
          type: "Text";
      } | {
          height: number;
          type: "Image";
          width: number;
      } | {
          height: number;
          type: "Video";
          width: number;
      } | {
          type: "Audio";
      }
      
      Description
      Parsed metadata of this file
    - Optional object_id?: string
      
      Description
      Id of the object this file is associated with
    - Optional reported?: boolean
      
      Description
      Whether this file was reported
    - Optional server_id?: string
    - size: number
      
      Format: int
      
      Description
      Size of this file (in bytes)
    - tag: string
      
      Description
      Tag / bucket this file was uploaded to
    - Optional user_id?: string
  - Optional categories?: {
        channels: string[];
        id: string;
        title: string;
    }[]
    
    Description
    Categories for this server
  - channels: string[]
    
    Description
    Channels within this server
  - default_permissions: number
    
    Format: int64
    
    Description
    Default set of server and channel permissions
  - Optional description?: string
    
    Description
    Description for the server
  - Optional discoverable?: boolean
    
    Description
    Whether this server should be publicly discoverable
  - Optional flags?: number
    
    Format: int32
    
    Description
    Bitfield of server flags
  - Optional icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    }
    
    Description
    Icon attachment
    - _id: string
      
      Description
      Unique Id
    - content_type: string
      
      Description
      Raw content type of this file
    - Optional deleted?: boolean
      
      Description
      Whether this file was deleted
    - filename: string
      
      Description
      Original filename
    - Optional message_id?: string
    - metadata: {
          type: "File";
      } | {
          type: "Text";
      } | {
          height: number;
          type: "Image";
          width: number;
      } | {
          height: number;
          type: "Video";
          width: number;
      } | {
          type: "Audio";
      }
      
      Description
      Parsed metadata of this file
    - Optional object_id?: string
      
      Description
      Id of the object this file is associated with
    - Optional reported?: boolean
      
      Description
      Whether this file was reported
    - Optional server_id?: string
    - size: number
      
      Format: int
      
      Description
      Size of this file (in bytes)
    - tag: string
      
      Description
      Tag / bucket this file was uploaded to
    - Optional user_id?: string
  - name: string
    
    Description
    Name of the server
  - Optional nsfw?: boolean
    
    Description
    Whether this server is flagged as not safe for work
  - owner: string
    
    Description
    User id of the owner
  - Optional roles?: {
    [key: string]: components["schemas"]["Role"];
    }
    
    Description
    Roles for this server
    - [key: string]: components["schemas"]["Role"]
  - Optional system_messages?: {
        user_banned?: string;
        user_joined?: string;
        user_kicked?: string;
        user_left?: string;
    }
    
    Description
    Configuration for sending system event messages
    - Optional user_banned?: string
      
      Description
      ID of channel to send user banned messages in
    - Optional user_joined?: string
      
      Description
      ID of channel to send user join messages in
    - Optional user_kicked?: string
      
      Description
      ID of channel to send user kicked messages in
    - Optional user_left?: string
      
      Description
      ID of channel to send user left messages in
- Optional channels: ({
      _id: string;
      channel_type: "SavedMessages";
      user: string;
  } | {
      _id: string;
      active: boolean;
      channel_type: "DirectMessage";
      last_message_id?: string;
      recipients: string[];
  } | {
      _id: string;
      channel_type: "Group";
      description?: string;
      icon?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      last_message_id?: string;
      name: string;
      nsfw?: boolean;
      owner: string;
      permissions?: number;
      recipients: string[];
  } | {
      _id: string;
      channel_type: "TextChannel";
      default_permissions?: {
          a: number;
          d: number;
      };
      description?: string;
      icon?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      last_message_id?: string;
      name: string;
      nsfw?: boolean;
      role_permissions?: {
          [key: string]: components["schemas"]["OverrideField"];
      };
      server: string;
  } | {
      _id: string;
      channel_type: "VoiceChannel";
      default_permissions?: {
          a: number;
          d: number;
      };
      description?: string;
      icon?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      name: string;
      nsfw?: boolean;
      role_permissions?: {
          [key: string]: components["schemas"]["OverrideField"];
      };
      server: string;
  })[]
Returns Promise<Server>
- Defined in core/src/managers/ServerManager.ts:21

filter

filter(...d: [predicate: ((value: Server, index: number, array: Server[]) => unknown), thisArg?: any]): Server[]
Parameters
- Rest ...d: [predicate: ((value: Server, index: number, array: Server[]) => unknown), thisArg?: any]
Returns Server[]
Inherited from BaseManager.filter
- Defined in core/src/managers/BaseManager.ts:27

find

find(...d: [predicate: ((value: Server, index: number, obj: Server[]) => unknown), thisArg?: any]): Server
Parameters
- Rest ...d: [predicate: ((value: Server, index: number, obj: Server[]) => unknown), thisArg?: any]
Returns Server
Inherited from BaseManager.find
- Defined in core/src/managers/BaseManager.ts:24

fireUpdate

fireUpdate(updated?: Server[]): void
Runs all of the callbacks for this emitter. (meant to run when an update occurs)
Parameters
- Optional updated: Server[]
  
  The objects that caused this update.
Returns void
Inherited from BaseManager.fireUpdate
- Defined in core/src/utils/MiniEmitter.ts:67

forEach

forEach(callbackfn: ((value: Server, key: string, map: Map<string, Server>) => void), thisArg?: any): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value: Server, key: string, map: Map<string, Server>) => void)
  - - (value: Server, key: string, map: Map<string, Server>): void
    - Parameters
      
      value: Server
      
      key: string
      
      map: Map<string, Server>
      
      Returns void
- Optional thisArg: any
Returns void
Inherited from BaseManager.forEach
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:29

get

get(key: string): Server
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

Returns
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Parameters
- key: string
Returns Server
Inherited from BaseManager.get
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:34

has

has(key: string): boolean
Returns
boolean indicating whether an element with the specified key exists or not.
Parameters
- key: string
Returns boolean
Inherited from BaseManager.has
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:38

items

items(): Server[]
Returns Server[]
Inherited from BaseManager.items
- Defined in core/src/managers/BaseManager.ts:20

keys

keys(): IterableIterator<string>
Returns an iterable of keys in the map

Returns IterableIterator<string>
Inherited from BaseManager.keys
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

map

map<U>(callbackfn: ((value: Server, index: number, array: Server[]) => U)): U[]
Type Parameters
- U
Parameters
- callbackfn: ((value: Server, index: number, array: Server[]) => U)
  - - (value: Server, index: number, array: Server[]): U
    - Parameters
      
      value: Server
      
      index: number
      
      array: Server[]
      
      Returns U
Returns U[]
Inherited from BaseManager.map
- Defined in core/src/managers/BaseManager.ts:30

offUpdate

offUpdate(callback: MiniEmitterCallback<Server>): ServerManager
Stops listening for Map updates.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<Server>
  
  The callback to stop listening for updates on.
Returns ServerManager
Inherited from BaseManager.offUpdate
- Defined in core/src/utils/MiniEmitter.ts:58

onUpdate

onUpdate(callback: MiniEmitterCallback<Server>): ServerManager
Listen for an update to this Map.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<Server>
  
  The callback to run when an update occurs.
Returns ServerManager
Inherited from BaseManager.onUpdate
- Defined in core/src/utils/MiniEmitter.ts:49

set

set(key: string, value: Server): ServerManager
Parameters
- key: string
- value: Server
Returns ServerManager
Inherited from BaseManager.set
- Defined in core/src/managers/BaseManager.ts:9

sort

sort(...d: [compareFn?: ((a: Server, b: Server) => number)]): Server[]
Parameters
- Rest ...d: [compareFn?: ((a: Server, b: Server) => number)]
Returns Server[]
Inherited from BaseManager.sort
- Defined in core/src/managers/BaseManager.ts:33

values

values(): IterableIterator<Server>
Returns an iterable of values in the map

Returns IterableIterator<Server>
Inherited from BaseManager.values
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

Class ServerManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns ServerManager

Properties

Readonly [toStringTag]

Private client

Readonly size

Returns

Static Readonly [species]

Methods

[iterator]

Returns IterableIterator<[string, Server]>

clear

Returns void

construct

Parameters

_id: string

Description

Optional analytics?: boolean

Description

Description

_id: string

Description

content_type: string

Description

Optional deleted?: boolean

Description

filename: string

Description

Optional message_id?: string

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

Description

Optional object_id?: string

Description

Optional reported?: boolean

Description

Optional server_id?: string

size: number

Description

tag: string

Description

Optional user_id?: string

Optional categories?: { channels: string[]; id: string; title: string; }[]

Description

channels: string[]

Description

default_permissions: number

Description

Optional description?: string

Description

Optional discoverable?: boolean

Description

Optional flags?: number

Description

Description

_id: string

Description

content_type: string

Description

Optional deleted?: boolean

Description

filename: string

Description

Optional message_id?: string

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

Description

Optional object_id?: string

Description

Optional reported?: boolean

Description

Optional server_id?: string

size: number

`Readonly` [toStringTag]

`Private` client

`Readonly` size

`Static` `Readonly` [species]

`Optional` analytics?: boolean

`Optional` deleted?: boolean

`Optional` message_id?: string

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

`Optional` object_id?: string

`Optional` reported?: boolean

`Optional` server_id?: string

`Optional` user_id?: string

`Optional` categories?: {
channels: string[];
id: string;
title: string;
}[]

`Optional` description?: string

`Optional` discoverable?: boolean

`Optional` flags?: number

`Optional` deleted?: boolean

`Optional` message_id?: string

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

`Optional` object_id?: string

`Optional` reported?: boolean

`Optional` server_id?: string

`Optional` user_id?: string

`Optional` nsfw?: boolean

`Optional` roles?: {
[key: string]: components["schemas"]["Role"];
}

`Optional` system_messages?: {
user_banned?: string;
user_joined?: string;
user_kicked?: string;
user_left?: string;
}

`Optional` user_banned?: string

`Optional` user_joined?: string

`Optional` user_kicked?: string

`Optional` user_left?: string

`Optional` analytics?: boolean

`Optional` deleted?: boolean

`Optional` message_id?: string

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

`Optional` object_id?: string

`Optional` reported?: boolean

`Optional` server_id?: string

`Optional` user_id?: string

`Optional` categories?: {
channels: string[];
id: string;
title: string;
}[]