Class UserManager

Hierarchy

BaseManager<User>
- UserManager

Index

Constructors

constructor

new UserManager(client: Client): UserManager
Parameters
- client: Client
Returns UserManager
Overrides BaseManager<User>.constructor
- Defined in core/src/managers/UserManager.ts:7

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

Accessors

self

get self(): User
Returns User
- Defined in core/src/managers/UserManager.ts:11

Methods

[iterator]

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

Returns IterableIterator<[string, User]>
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;
    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;
    };
    badges?: number;
    bot?: {
        owner: string;
    };
    discriminator: string;
    display_name?: string;
    flags?: number;
    online?: boolean;
    privileged?: boolean;
    profile?: {
        background?: {
            _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;
        };
        content?: string;
    };
    relations?: {
        _id: string;
        status: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
    }[];
    relationship?: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
    status?: {
        presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
        text?: string;
    };
    username: string;
}): User
Parameters
- data: {
      _id: 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;
      };
      badges?: number;
      bot?: {
          owner: string;
      };
      discriminator: string;
      display_name?: string;
      flags?: number;
      online?: boolean;
      privileged?: boolean;
      profile?: {
          background?: {
              _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;
          };
          content?: string;
      };
      relations?: {
          _id: string;
          status: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
      }[];
      relationship?: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
      status?: {
          presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
          text?: string;
      };
      username: string;
  }
  - _id: string
    
    Description
    Unique 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
  - Optional badges?: number
    
    Format: int32
    
    Description
    Bitfield of user badges
  - Optional bot?: {
    owner: string;
    }
    
    Description
    Bot information
    - owner: string
      
      Description
      Id of the owner of this bot
  - discriminator: string
    
    Description
    Discriminator
  - Optional display_name?: string
    
    Description
    Display name
  - Optional flags?: number
    
    Format: int32
    
    Description
    Enum of user flags
  - Optional online?: boolean
    
    Description
    Whether this user is currently online
  - Optional privileged?: boolean
    
    Description
    Whether this user is privileged
  - Optional profile?: {
        background?: {
            _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;
        };
        content?: string;
    }
    
    Description
    User's profile page
    - Optional background?: {
          _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
      Background visible on user's profile
      
      _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
    - Optional content?: string
      
      Description
      Text content on user's profile
  - Optional relations?: {
    _id: string;
    status: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
    }[]
    
    Description
    Relationships with other users
  - Optional relationship?: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther"
    
    Description
    Current session user's relationship with this user
  - Optional status?: {
    presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
    text?: string;
    }
    
    Description
    User's current status
    - Optional presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible"
      
      Description
      Current presence option
    - Optional text?: string
      
      Description
      Custom status text
  - username: string
    
    Description
    Username
Returns User
- Defined in core/src/managers/UserManager.ts:18

defaultAvatarURL

defaultAvatarURL(id: string): string
Parameters
- id: string
Returns string
- Defined in core/src/managers/UserManager.ts:14

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

Returns IterableIterator<[string, User]>
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<User>
Parameters
- id: string
- fetchNew: boolean = false
Returns Promise<User>
- Defined in core/src/managers/UserManager.ts:28

filter

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

find

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

fireUpdate

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

forEach

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

offUpdate

offUpdate(callback: MiniEmitterCallback<User>): UserManager
Stops listening for Map updates.

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

onUpdate

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

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

set

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

sort

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

values

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

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

Class UserManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

Returns UserManager

Properties

Readonly [toStringTag]

Private client

Readonly size

Returns

Static Readonly [species]

Accessors

self

Returns User

Methods

[iterator]

Returns IterableIterator<[string, User]>

clear

Returns void

construct

Parameters

_id: 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

Optional badges?: number

Description

Optional bot?: { owner: string; }

Description

owner: string

Description

discriminator: string

Description

Optional display_name?: string

Description

Optional flags?: number

Description

Optional online?: boolean

Description

Optional privileged?: boolean

Description

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

`Readonly` [toStringTag]

`Private` client

`Readonly` size

`Static` `Readonly` [species]

`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` badges?: number

`Optional` bot?: {
owner: string;
}

`Optional` display_name?: string

`Optional` flags?: number

`Optional` online?: boolean

`Optional` privileged?: boolean

`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` content?: string

`Optional` relations?: {
_id: string;
status: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
}[]

`Optional` relationship?: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther"

`Optional` status?: {
presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
text?: string;
}

`Optional` presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible"

`Optional` text?: string

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

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

`Optional` updated: User[]

`Optional` thisArg: any