Class ServerCollection

Collection of Servers

Hierarchy

ClassCollection<Server, HydratedServer>
- ServerCollection

Index

Constructors

constructor

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

Properties

`Private` #objects

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

`Private` #storage

#storage: ObjectStorage<HydratedServer> = ...

`Readonly` client

client: Client

`Readonly` getUnderlyingObject

getUnderlyingObject: ((id) => HydratedServer)

Type declaration

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

`Readonly` updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedServer>>

Methods

create

create(id, type, instance, context, data?): 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
- Optional data: unknown
  
  Data
Returns void
Inherited from ClassCollection.create
- Defined in src/collections/Collection.ts:167

createServer

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

delete

delete(id): 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): 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:21

filter

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

find

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

forEach

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

get

get(id): 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, data, isNew?): 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]: components["schemas"]["Role"];
      };
      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
  - Optional analytics?: boolean
    
    Description
    Whether to enable analytics
  - Optional 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;
    }
    
    Description
    Banner attachment
  - Optional categories?: 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
  - Optional description?: null | string
    
    Description
    Description for the server
  - Optional discoverable?: boolean
    
    Description
    Whether this server should be publicly discoverable
  - Optional flags?: number
    
    Format: uint32
    
    Description
    Bitfield of server flags
  - Optional 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;
    }
    
    Description
    Icon attachment
  - 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?: 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:45

getOrPartial

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

has

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

size

size(): number
Number of stored objects

Returns 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

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns ServerCollection

Properties

Private #objects

Private #storage

Readonly client

Readonly getUnderlyingObject

Type declaration

Parameters

id: string

Returns HydratedServer

Readonly updateUnderlyingObject

Methods

create

Parameters

id: string

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

instance: Server

context: unknown

Optional data: unknown

Returns void

createServer

Parameters

data: { description?: null | string; name: string; nsfw?: null | boolean; }

Optional description?: null | string

Description

name: string

Description

Optional nsfw?: null | boolean

Description

Returns Promise<Server>

delete

Parameters

id: string

Returns void

entries

Returns IterableIterator<[string, Server]>

fetch

Parameters

id: string

Returns Promise<Server>

filter

Parameters

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

Parameters

value: Server

key: string

Returns boolean

Returns Server[]

find

Parameters

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

Parameters

value: Server

key: string

Returns boolean

Returns undefined | Server

forEach

Parameters

cb: ((value, key, map) => void)

Parameters

value: Server

key: string

map: ReactiveMap<string, Server>

Returns void

Returns void

get

Parameters

id: string

Returns undefined | Server

getOrCreate

`Private` #objects

`Private` #storage

`Readonly` client

`Readonly` getUnderlyingObject

`Readonly` updateUnderlyingObject

`Optional` data: unknown

data: {
description?: null | string;
name: string;
nsfw?: null | boolean;
}

`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]: components["schemas"]["Role"];
}

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