Class ServerManager

Hierarchy (View Summary)

BaseManager<Server, API.Server>
- ServerManager

Index

Constructors

constructor

new ServerManager(client: client, maxSize?: number): ServerManager
Parameters
- client: client
- maxSize: number = BaseManager.defaultMaxSize
Returns ServerManager
Inherited from BaseManager.constructor
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:15

Properties

`Readonly`cache

cache: Map<string, Server> = ...

Insertion ordered cache of items this manager holds.

`Readonly`holds

holds: typeof Server = Server

Holds

Holds: any

`Static`defaultMaxSize

defaultMaxSize: number = -1

Shared default max size for all managers (can be changed globally).

Methods

_add

_add(
    raw: {
        _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?: 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]: {
                colour?: null
                | string;
                hoist?: boolean;
                name: string;
                permissions: { a: number; d: number };
                rank?: number;
            };
        };
        system_messages?: | null
        | {
            user_banned?: null
            | string;
            user_joined?: null | string;
            user_kicked?: null | string;
            user_left?: null | string;
        };
    },
): Server
Adds a raw object to the cache, constructing the holdable class. Automatically evicts oldest entries if the max size is exceeded.
Parameters
- raw: {
      _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?: 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]: {
              colour?: null
              | string;
              hoist?: boolean;
              name: string;
              permissions: { a: number; d: number };
              rank?: number;
          };
      };
      system_messages?: | null
      | {
          user_banned?: null
          | string;
          user_joined?: null | string;
          user_kicked?: null | string;
          user_left?: null | string;
      };
  }
  - _id: string
    Description
    Unique Id
  - Optionalanalytics?: boolean
    Description
    Whether to enable analytics
  - Optionalbanner?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }
    Description
    Banner attachment
  - Optionalcategories?: null | { 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
  - Optionaldescription?: null | string
    Description
    Description for the server
  - Optionaldiscoverable?: boolean
    Description
    Whether this server should be publicly discoverable
  - Optionalflags?: number
    Format: uint32
    
    Description
    Bitfield of server flags
  - Optionalicon?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }
    Description
    Icon attachment
  - name: string
    Description
    Name of the server
  - Optionalnsfw?: boolean
    Description
    Whether this server is flagged as not safe for work
  - owner: string
    Description
    User id of the owner
  - Optionalroles?: {
        [key: string]: {
            colour?: null | string;
            hoist?: boolean;
            name: string;
            permissions: { a: number; d: number };
            rank?: number;
        };
    }
    Description
    Roles for this server
  - Optionalsystem_messages?:
        | null
        | {
            user_banned?: null
            | string;
            user_joined?: null | string;
            user_kicked?: null | string;
            user_left?: null | string;
        }
    Description
    Configuration for sending system event messages
Returns Server
Inherited from BaseManager._add
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:26

_remove

_remove(id: string): void
Remove an entry by id.
Parameters
- id: string
Returns void
Overrides BaseManager._remove
- Defined in work/revbot.js/revbot.js/src/managers/serverManager.ts:15

delete

delete(server: ServerResolvable): Promise<void>
leaves a server
Parameters
- server: ServerResolvable
  the server to leave
Returns Promise<void>
- Defined in work/revbot.js/revbot.js/src/managers/serverManager.ts:46

edit

edit(server: ServerResolvable, options: EditServerOptions): Promise<void>
edits a server
Parameters
- server: ServerResolvable
  The server to edit
- options: EditServerOptions
  The options to edit the server with
  - Optionaldescription?: string
  - Optionalname?: string
Returns Promise<void>
A promise that resolves when the server is edited
- Defined in work/revbot.js/revbot.js/src/managers/serverManager.ts:33

fetch

fetch(
server: ServerResolvable,
__namedParameters?: { force?: boolean },
): Promise<Server>
Parameters
- server: ServerResolvable
- __namedParameters: { force?: boolean } = {}
Returns Promise<Server>
- Defined in work/revbot.js/revbot.js/src/managers/serverManager.ts:52

resolve

resolve(resolvable: Server): null | Server
Parameters
- resolvable: Server
Returns null | Server
Inherited from BaseManager.resolve
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:64
resolve(
    resolvable:
        | string
        | {
            _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?: 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]: {
                    colour?: null
                    | string;
                    hoist?: boolean;
                    name: string;
                    permissions: { a: number; d: number };
                    rank?: number;
                };
            };
            system_messages?: | null
            | {
                user_banned?: null
                | string;
                user_joined?: null | string;
                user_kicked?: null | string;
                user_left?: null | string;
            };
        },
): null
| Server
Parameters
- resolvable:
      | string
      | {
          _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?: 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]: {
                  colour?: null
                  | string;
                  hoist?: boolean;
                  name: string;
                  permissions: { a: number; d: number };
                  rank?: number;
              };
          };
          system_messages?: | null
          | {
              user_banned?: null
              | string;
              user_joined?: null | string;
              user_kicked?: null | string;
              user_left?: null | string;
          };
      }
  - string
  - {
        _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?: 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]: {
                colour?: null
                | string;
                hoist?: boolean;
                name: string;
                permissions: { a: number; d: number };
                rank?: number;
            };
        };
        system_messages?: | null
        | {
            user_banned?: null
            | string;
            user_joined?: null | string;
            user_kicked?: null | string;
            user_left?: null | string;
        };
    }
    _id: string
    Description
    Unique Id
    
    Optionalanalytics?: boolean
    Description
    Whether to enable analytics
    
    Optionalbanner?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }
    Description
    Banner attachment
    
    Optionalcategories?: null | { 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
    
    Optionaldescription?: null | string
    Description
    Description for the server
    
    Optionaldiscoverable?: boolean
    Description
    Whether this server should be publicly discoverable
    
    Optionalflags?: number
    Format: uint32
    
    Description
    Bitfield of server flags
    
    Optionalicon?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }
    Description
    Icon attachment
    
    name: string
    Description
    Name of the server
    
    Optionalnsfw?: boolean
    Description
    Whether this server is flagged as not safe for work
    
    owner: string
    Description
    User id of the owner
    
    Optionalroles?: {
        [key: string]: {
            colour?: null | string;
            hoist?: boolean;
            name: string;
            permissions: { a: number; d: number };
            rank?: number;
        };
    }
    Description
    Roles for this server
    
    Optionalsystem_messages?:
        | null
        | {
            user_banned?: null
            | string;
            user_joined?: null | string;
            user_kicked?: null | string;
            user_left?: null | string;
        }
    Description
    Configuration for sending system event messages
Returns null | Server
Inherited from BaseManager.resolve
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:65
resolve(
    resolvable:
        | string
        | Server
        | {
            _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?: 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]: {
                    colour?: null
                    | string;
                    hoist?: boolean;
                    name: string;
                    permissions: { a: number; d: number };
                    rank?: number;
                };
            };
            system_messages?: | null
            | {
                user_banned?: null
                | string;
                user_joined?: null | string;
                user_kicked?: null | string;
                user_left?: null | string;
            };
        },
): null
| Server
Parameters
- resolvable:
      | string
      | Server
      | {
          _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?: 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]: {
                  colour?: null
                  | string;
                  hoist?: boolean;
                  name: string;
                  permissions: { a: number; d: number };
                  rank?: number;
              };
          };
          system_messages?: | null
          | {
              user_banned?: null
              | string;
              user_joined?: null | string;
              user_kicked?: null | string;
              user_left?: null | string;
          };
      }
  - string
  - Server
  - {
        _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?: 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]: {
                colour?: null
                | string;
                hoist?: boolean;
                name: string;
                permissions: { a: number; d: number };
                rank?: number;
            };
        };
        system_messages?: | null
        | {
            user_banned?: null
            | string;
            user_joined?: null | string;
            user_kicked?: null | string;
            user_left?: null | string;
        };
    }
    _id: string
    Description
    Unique Id
    
    Optionalanalytics?: boolean
    Description
    Whether to enable analytics
    
    Optionalbanner?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }
    Description
    Banner attachment
    
    Optionalcategories?: null | { 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
    
    Optionaldescription?: null | string
    Description
    Description for the server
    
    Optionaldiscoverable?: boolean
    Description
    Whether this server should be publicly discoverable
    
    Optionalflags?: number
    Format: uint32
    
    Description
    Bitfield of server flags
    
    Optionalicon?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }
    Description
    Icon attachment
    
    name: string
    Description
    Name of the server
    
    Optionalnsfw?: boolean
    Description
    Whether this server is flagged as not safe for work
    
    owner: string
    Description
    User id of the owner
    
    Optionalroles?: {
        [key: string]: {
            colour?: null | string;
            hoist?: boolean;
            name: string;
            permissions: { a: number; d: number };
            rank?: number;
        };
    }
    Description
    Roles for this server
    
    Optionalsystem_messages?:
        | null
        | {
            user_banned?: null
            | string;
            user_joined?: null | string;
            user_kicked?: null | string;
            user_left?: null | string;
        }
    Description
    Configuration for sending system event messages
Returns null | Server
Inherited from BaseManager.resolve
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:66

resolveId

resolveId(
    resolvable:
        | string
        | Server
        | {
            _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?: 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]: {
                    colour?: null
                    | string;
                    hoist?: boolean;
                    name: string;
                    permissions: { a: number; d: number };
                    rank?: number;
                };
            };
            system_messages?: | null
            | {
                user_banned?: null
                | string;
                user_joined?: null | string;
                user_kicked?: null | string;
                user_left?: null | string;
            };
        },
): null
| string
Parameters
- resolvable:
      | string
      | Server
      | {
          _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?: 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]: {
                  colour?: null
                  | string;
                  hoist?: boolean;
                  name: string;
                  permissions: { a: number; d: number };
                  rank?: number;
              };
          };
          system_messages?: | null
          | {
              user_banned?: null
              | string;
              user_joined?: null | string;
              user_kicked?: null | string;
              user_left?: null | string;
          };
      }
  - string
  - Server
  - {
        _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?: 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]: {
                colour?: null
                | string;
                hoist?: boolean;
                name: string;
                permissions: { a: number; d: number };
                rank?: number;
            };
        };
        system_messages?: | null
        | {
            user_banned?: null
            | string;
            user_joined?: null | string;
            user_kicked?: null | string;
            user_left?: null | string;
        };
    }
    _id: string
    Description
    Unique Id
    
    Optionalanalytics?: boolean
    Description
    Whether to enable analytics
    
    Optionalbanner?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }
    Description
    Banner attachment
    
    Optionalcategories?: null | { 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
    
    Optionaldescription?: null | string
    Description
    Description for the server
    
    Optionaldiscoverable?: boolean
    Description
    Whether this server should be publicly discoverable
    
    Optionalflags?: number
    Format: uint32
    
    Description
    Bitfield of server flags
    
    Optionalicon?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }
    Description
    Icon attachment
    
    name: string
    Description
    Name of the server
    
    Optionalnsfw?: boolean
    Description
    Whether this server is flagged as not safe for work
    
    owner: string
    Description
    User id of the owner
    
    Optionalroles?: {
        [key: string]: {
            colour?: null | string;
            hoist?: boolean;
            name: string;
            permissions: { a: number; d: number };
            rank?: number;
        };
    }
    Description
    Roles for this server
    
    Optionalsystem_messages?:
        | null
        | {
            user_banned?: null
            | string;
            user_joined?: null | string;
            user_kicked?: null | string;
            user_left?: null | string;
        }
    Description
    Configuration for sending system event messages
Returns null | string
Inherited from BaseManager.resolveId
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:73

setMaxSize

setMaxSize(size: number): void
Adjust the maximum size for this manager at runtime.
Parameters
- size: number
Returns void
Inherited from BaseManager.setMaxSize
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:40

valueOf

valueOf(): Map<string, Server>
Returns Map<string, Server>
Inherited from BaseManager.valueOf
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:82

Class ServerManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ServerManager

Properties

Readonlycache

Readonlyholds

Holds

StaticdefaultMaxSize

Methods

_add

Parameters

_id: string

Description

Optionalanalytics?: boolean

Description

Description

Optionalcategories?: null | { channels: string[]; id: string; title: string }[]

Description

channels: string[]

Description

default_permissions: number

Description

Optionaldescription?: null | string

Description

Optionaldiscoverable?: boolean

Description

Optionalflags?: number

Description

Description

name: string

Description

Optionalnsfw?: boolean

Description

owner: string

Description

Optionalroles?: { [key: string]: { colour?: null | string; hoist?: boolean; name: string; permissions: { a: number; d: number }; rank?: number; };}

Description

Optionalsystem_messages?: | null | { user_banned?: null | string; user_joined?: null | string; user_kicked?: null | string; user_left?: null | string; }

Description

Returns Server

_remove

Parameters

Returns void

delete

Parameters

Returns Promise<void>

edit

Parameters

Optionaldescription?: string

Optionalname?: string

Returns Promise<void>

fetch

Parameters

Returns Promise<Server>

resolve

Parameters

Returns null | Server

Parameters

_id: string

Description

Optionalanalytics?: boolean

Description

Description

Optionalcategories?: null | { channels: string[]; id: string; title: string }[]

Description

channels: string[]

Description

default_permissions: number

Description

Optionaldescription?: null | string

Description

Optionaldiscoverable?: boolean

Description

`Readonly`cache

`Readonly`holds

`Static`defaultMaxSize

`Optional`analytics?: boolean

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

`Optional`description?: null | string

`Optional`discoverable?: boolean

`Optional`flags?: number

`Optional`nsfw?: boolean

`Optional`roles?: {
[key: string]: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: { a: number; d: number };
rank?: number;
};
}

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

`Optional`description?: string

`Optional`name?: string

`Optional`analytics?: boolean

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

`Optional`description?: null | string

`Optional`discoverable?: boolean

`Optional`flags?: number

`Optional`nsfw?: boolean

`Optional`roles?: {
[key: string]: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: { a: number; d: number };
rank?: number;
};
}

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

`Optional`analytics?: boolean

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

`Optional`description?: null | string

`Optional`discoverable?: boolean

`Optional`flags?: number

`Optional`nsfw?: boolean

`Optional`roles?: {
[key: string]: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: { a: number; d: number };
rank?: number;
};
}

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

`Optional`analytics?: boolean

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

`Optional`description?: null | string

`Optional`discoverable?: boolean

`Optional`flags?: number