Class ChannelManager

Hierarchy

BaseManager<Channel>
- ChannelManager

Index

Constructors

Properties

Methods

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

Constructors

constructor

new ChannelManager(client: Client): ChannelManager
Parameters
- client: Client
Returns ChannelManager
Overrides BaseManager<Channel>.constructor
- Defined in core/src/managers/ChannelManager.ts:14

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, Channel]>
Returns an iterable of entries in the map.

Returns IterableIterator<[string, Channel]>
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;
    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;
}): Channel
Parameters
- data: {
      _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 Channel
- Defined in core/src/managers/ChannelManager.ts:18

create

create(server: Server, data: {
    description?: string;
    name: string;
    nsfw?: boolean;
    type?: "Text" | "Voice";
}): Promise<Channel>
Parameters
- server: Server
- data: {
      description?: string;
      name: string;
      nsfw?: boolean;
      type?: "Text" | "Voice";
  }
  - Optional description?: string
    
    Description
    Channel description
  - name: string
    
    Description
    Channel name
  - Optional nsfw?: boolean
    
    Description
    Whether this channel is age restricted
  - Optional type?: "Text" | "Voice"
    
    Description
    Channel type
    
    Default
    Text
Returns Promise<Channel>
- Defined in core/src/managers/ChannelManager.ts:46

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, Channel]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[string, Channel]>
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;
    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<Channel>
Parameters
- id: string
- Optional data: {
      _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<Channel>
- Defined in core/src/managers/ChannelManager.ts:41

filter

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

find

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

fireUpdate

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

forEach

forEach(callbackfn: ((value: Channel, key: string, map: Map<string, Channel>) => void), thisArg?: any): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value: Channel, key: string, map: Map<string, Channel>) => void)
  - - (value: Channel, key: string, map: Map<string, Channel>): void
    - Parameters
      
      value: Channel
      
      key: string
      
      map: Map<string, Channel>
      
      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): Channel
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 Channel
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(): Channel[]
Returns Channel[]
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: Channel, index: number, array: Channel[]) => U)): U[]
Type Parameters
- U
Parameters
- callbackfn: ((value: Channel, index: number, array: Channel[]) => U)
  - - (value: Channel, index: number, array: Channel[]): U
    - Parameters
      
      value: Channel
      
      index: number
      
      array: Channel[]
      
      Returns U
Returns U[]
Inherited from BaseManager.map
- Defined in core/src/managers/BaseManager.ts:30

offUpdate

offUpdate(callback: MiniEmitterCallback<Channel>): ChannelManager
Stops listening for Map updates.

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

onUpdate

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

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

set

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

sort

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

values

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

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

Class ChannelManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns ChannelManager

Properties

Readonly [toStringTag]

Private client

Readonly size

Returns

Static Readonly [species]

Methods

[iterator]

Returns IterableIterator<[string, Channel]>

clear

Returns void

construct

Parameters

Returns Channel

create

Parameters

server: Server

data: { description?: string; name: string; nsfw?: boolean; type?: "Text" | "Voice"; }

Optional description?: string

Description

name: string

Description

Optional nsfw?: boolean

Description

Optional type?: "Text" | "Voice"

Description

Default

Returns Promise<Channel>

delete

Parameters

key: string

Returns boolean

entries

Returns IterableIterator<[string, Channel]>

fetch

Parameters

id: string

Returns Promise<Channel>

filter

Parameters

Rest ...d: [predicate: ((value: Channel, index: number, array: Channel[]) => unknown), thisArg?: any]

Returns Channel[]

find

Parameters

Rest ...d: [predicate: ((value: Channel, index: number, obj: Channel[]) => unknown), thisArg?: any]

Returns Channel

fireUpdate

Parameters

Optional updated: Channel[]

Returns void

forEach

Parameters

callbackfn: ((value: Channel, key: string, map: Map<string, Channel>) => void)

Parameters

value: Channel

key: string

map: Map<string, Channel>

Returns void

Optional thisArg: any

Returns void

get

Returns

Parameters

key: string

Returns Channel

has

Returns

Parameters

key: string

`Readonly` [toStringTag]

`Private` client

`Readonly` size

`Static` `Readonly` [species]

data: {
description?: string;
name: string;
nsfw?: boolean;
type?: "Text" | "Voice";
}

`Optional` description?: string

`Optional` nsfw?: boolean

`Optional` type?: "Text" | "Voice"

`Rest` ...d: [predicate: ((value: Channel, index: number, array: Channel[]) => unknown), thisArg?: any]

`Rest` ...d: [predicate: ((value: Channel, index: number, obj: Channel[]) => unknown), thisArg?: any]

`Optional` updated: Channel[]

`Optional` thisArg: any

`Rest` ...d: [compareFn?: ((a: Channel, b: Channel) => number)]