Class MemberManager

Hierarchy

BaseManager<Member>
- MemberManager

Index

Constructors

constructor

new MemberManager(client: Client, server: Server): MemberManager
Parameters
- client: Client
- server: Server
Returns MemberManager
Overrides BaseManager<Member>.constructor
- Defined in core/src/managers/MemberManager.ts:9

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Private` client

client: Client

`Private` server

server: Server

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Accessors

self

get self(): Member
Returns Member
- Defined in core/src/managers/MemberManager.ts:13

Methods

[iterator]

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

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

ban

ban(member: string | Member, data?: {
reason?: string;
}): Promise<void>
Ban a member from the server.
Parameters
- member: string | Member
- Optional data: {
  reason?: string;
  }
  - Optional reason?: string
    
    Description
    Ban reason
Returns Promise<void>
- Defined in core/src/managers/MemberManager.ts:18

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: {
        server: string;
        user: string;
    };
    avatar?: {
        _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;
    };
    joined_at: string;
    nickname?: string;
    roles?: string[];
    timeout?: string;
}): Member
Parameters
- data: {
      _id: {
          server: string;
          user: string;
      };
      avatar?: {
          _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;
      };
      joined_at: string;
      nickname?: string;
      roles?: string[];
      timeout?: string;
  }
  - _id: {
    server: string;
    user: string;
    }
    
    Description
    Unique member id
    - server: string
      
      Description
      Server Id
    - user: string
      
      Description
      User Id
  - Optional avatar?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    }
    
    Description
    Avatar attachment
    - _id: string
      
      Description
      Unique Id
    - content_type: string
      
      Description
      Raw content type of this file
    - Optional deleted?: boolean
      
      Description
      Whether this file was deleted
    - filename: string
      
      Description
      Original filename
    - Optional message_id?: string
    - metadata: {
          type: "File";
      } | {
          type: "Text";
      } | {
          height: number;
          type: "Image";
          width: number;
      } | {
          height: number;
          type: "Video";
          width: number;
      } | {
          type: "Audio";
      }
      
      Description
      Parsed metadata of this file
    - Optional object_id?: string
      
      Description
      Id of the object this file is associated with
    - Optional reported?: boolean
      
      Description
      Whether this file was reported
    - Optional server_id?: string
    - size: number
      
      Format: int
      
      Description
      Size of this file (in bytes)
    - tag: string
      
      Description
      Tag / bucket this file was uploaded to
    - Optional user_id?: string
  - joined_at: string
    
    Description
    Time at which this user joined the server
  - Optional nickname?: string
    
    Description
    Member's nickname
  - Optional roles?: string[]
    
    Description
    Member's roles
  - Optional timeout?: string
    
    Description
    Timestamp this member is timed out until
Returns Member
- Defined in core/src/managers/MemberManager.ts:29

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

Returns IterableIterator<[string, Member]>
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, fetchNew?: boolean): Promise<Member>
Parameters
- id: string
- fetchNew: boolean = false
Returns Promise<Member>
- Defined in core/src/managers/MemberManager.ts:39

fetchAll

fetchAll(excludeOffline?: boolean): Promise<Member[]>
Parameters
- excludeOffline: boolean = false
Returns Promise<Member[]>
- Defined in core/src/managers/MemberManager.ts:45

filter

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

find

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

fireUpdate

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

forEach

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

offUpdate

offUpdate(callback: MiniEmitterCallback<Member>): MemberManager
Stops listening for Map updates.

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

onUpdate

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

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

set

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

sort

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

unban

unban(id: string): Promise<void>
Unban a user from the server.
Parameters
- id: string
Returns Promise<void>
- Defined in core/src/managers/MemberManager.ts:25

values

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

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

Class MemberManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

server: Server

Returns MemberManager

Properties

Readonly [toStringTag]

Private client

Private server

Readonly size

Returns

Static Readonly [species]

Accessors

self

Returns Member

Methods

[iterator]

Returns IterableIterator<[string, Member]>

ban

Parameters

member: string | Member

Optional data: { reason?: string; }

Optional reason?: string

Description

Returns Promise<void>

clear

Returns void

construct

Parameters

_id: { server: string; user: string; }

Description

server: string

Description

user: string

Description

Description

_id: string

Description

content_type: string

Description

Optional deleted?: boolean

Description

filename: string

Description

Optional message_id?: string

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

Description

Optional object_id?: string

Description

Optional reported?: boolean

Description

Optional server_id?: string

size: number

Description

tag: string

Description

Optional user_id?: string

joined_at: string

Description

Optional nickname?: string

Description

Optional roles?: string[]

Description

Optional timeout?: string

Description

Returns Member

delete

Parameters

key: string

Returns boolean

entries

Returns IterableIterator<[string, Member]>

`Readonly` [toStringTag]

`Private` client

`Private` server

`Readonly` size

`Static` `Readonly` [species]

`Optional` data: {
reason?: string;
}

`Optional` reason?: string

_id: {
server: string;
user: string;
}

`Optional` deleted?: boolean

`Optional` message_id?: string

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

`Optional` object_id?: string

`Optional` reported?: boolean

`Optional` server_id?: string

`Optional` user_id?: string

`Optional` nickname?: string

`Optional` roles?: string[]

`Optional` timeout?: string

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

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

`Optional` updated: Member[]

`Optional` thisArg: any