Class ServerCollection

Collection of Servers

Hierarchy (View Summary)

ClassCollection<Server, HydratedServer>
- ServerCollection

Index

Constructors

constructor

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

Properties

`Readonly`client

client: Client

`Readonly`getUnderlyingObject

getUnderlyingObject: (id: string) => HydratedServer

`Readonly`updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedServer>>

Methods

create

create(
    id: string,
    type:
        | "user"
        | "server"
        | "channel"
        | "bot"
        | "channelUnread"
        | "channelWebhook"
        | "emoji"
        | "message"
        | "serverMember"
        | "session",
    instance: Server,
    context: unknown,
    data?: unknown,
): void
Create a new instance of an object
Parameters
- id: string
  Id
- type:
      | "user"
      | "server"
      | "channel"
      | "bot"
      | "channelUnread"
      | "channelWebhook"
      | "emoji"
      | "message"
      | "serverMember"
      | "session"
  Type
- instance: Server
  Instance
- context: unknown
  Context
- Optionaldata: unknown
  Data
Returns void
Inherited from ClassCollection.create
- Defined in src/collections/Collection.ts:167

createServer

createServer(
    data: {
        description?: null | string;
        name: string;
        nsfw?: null | boolean;
    },
): Promise<Server>
Create a server
Parameters
- data: { description?: null | string; name: string; nsfw?: null | boolean }
  Server options
  - Optionaldescription?: null | string
    Description
    Server description
  - name: string
    Description
    Server name
  - Optionalnsfw?: null | boolean
    Description
    Whether this server is age-restricted
Returns Promise<Server>
The newly-created server
- Defined in src/collections/ServerCollection.ts:82

delete

delete(id: string): void
Delete an object
Parameters
- id: string
  Id
Returns void
Inherited from ClassCollection.delete
- Defined in src/collections/Collection.ts:154

entries

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

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

fetch

fetch(id: string): Promise<Server>
Fetch server by ID

This will not fetch channels!
Parameters
- id: string
  Id
Returns Promise<Server>
Server
- Defined in src/collections/ServerCollection.ts:25

filter

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

find

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

forEach

forEach(
cb: (value: Server, key: string, map: Map<string, Server>) => void,
): void
Execute a provided function over each key, value pair in the map
Parameters
- cb: (value: Server, key: string, map: Map<string, Server>) => void
  Callback for each pair
Returns void
Iterable
Inherited from ClassCollection.forEach
- Defined in src/collections/Collection.ts:224

get

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

getOrCreate

getOrCreate(
    id: string,
    data: {
        _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;
        };
    },
    isNew?: boolean,
): Server
Get or create
Parameters
- id: string
  Id
- data: {
      _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;
      };
  }
  Data
  - _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
- isNew: boolean = false
  Whether this object is new
Returns Server
- Defined in src/collections/ServerCollection.ts:49

getOrPartial

getOrPartial(id: string): undefined | Server
Get or return partial
Parameters
- id: string
  Id
Returns undefined | Server
- Defined in src/collections/ServerCollection.ts:64

has

has(id: string): boolean
Check whether an id exists in the Collection
Parameters
- id: string
  Id
Returns boolean
Whether it exists
Inherited from ClassCollection.has
- Defined in src/collections/Collection.ts:146

isPartial

isPartial(id: string): boolean
Check whether an object is partially defined
Parameters
- id: string
  Id
Returns boolean
Whether it is a partial
Inherited from ClassCollection.isPartial
- Defined in src/collections/Collection.ts:183

keys

keys(): IterableIterator<string>
Iterable of keys in the map

Returns IterableIterator<string>
Iterable
Inherited from ClassCollection.keys
- Defined in src/collections/Collection.ts:199

map

map<O>(cb: (value: Server, key: string) => O): O[]
Map the collection using a given callback
Type Parameters
- O
Parameters
- cb: (value: Server, key: string) => O
  Callback
Returns O[]
Inherited from ClassCollection.map
- Defined in src/collections/Collection.ts:92

size

size(): number
Number of stored objects

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

toList

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

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

values

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

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

Class ServerCollection

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ServerCollection

Properties

Readonlyclient

ReadonlygetUnderlyingObject

ReadonlyupdateUnderlyingObject

Methods

create

Parameters

Returns void

createServer

Parameters

Optionaldescription?: null | string

Description

name: string

Description

Optionalnsfw?: null | boolean

Description

Returns Promise<Server>

delete

Parameters

Returns void

entries

Returns IterableIterator<[string, Server]>

fetch

Parameters

Returns Promise<Server>

filter

Parameters

Returns Server[]

find

Parameters

Returns undefined | Server

forEach

Parameters

Returns void

get

Parameters

Returns undefined | Server

getOrCreate

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

getOrPartial

Parameters

`Readonly`client

`Readonly`getUnderlyingObject

`Readonly`updateUnderlyingObject

`Optional`description?: null | string

`Optional`nsfw?: null | boolean

`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;
}