Class UserManager

Hierarchy (View Summary)

BaseManager<User, API.User>
- UserManager

Index

Constructors

constructor

new UserManager(client: client, maxSize?: number): UserManager
Parameters
- client: client
- maxSize: number = BaseManager.defaultMaxSize
Returns UserManager
Inherited from BaseManager.constructor
- Defined in work/stoatbot.js/stoatbot.js/src/managers/baseManager.ts:16

Properties

`Readonly`cache

cache: Map<string, User> = ...

Insertion ordered cache of items this manager holds.

`Static`defaultMaxSize

defaultMaxSize: number = -1

Shared default max size for all managers (can be changed globally).

Methods

fetch

fetch(
user: UserResolvable,
__namedParameters?: { force?: boolean },
): Promise<User>
Parameters
- user: UserResolvable
  The user to fetch
- __namedParameters: { force?: boolean } = {}
Returns Promise<User>
A promise that resolves when the user is fetched
- Defined in work/stoatbot.js/stoatbot.js/src/managers/userManager.ts:16

resolve

resolve(resolvable: User | MessageStruct): User | null
get a user form cache
Parameters
- resolvable: User | MessageStruct
  The user to resolve
Returns User | null
The user or null if it cannot be resolved
Overrides BaseManager.resolve
- Defined in work/stoatbot.js/stoatbot.js/src/managers/userManager.ts:36
resolve(
    resolvable:
        | string
        | {
            _id: string;
            avatar?: | {
                _id: string;
                content_type: string;
                deleted?: boolean
                | null;
                filename: string;
                message_id?: string | null;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: string | null;
                reported?: boolean | null;
                server_id?: string | null;
                size: number;
                tag: string;
                user_id?: string | null;
            }
            | null;
            badges?: number;
            bot?: { owner: string }
            | null;
            discriminator: string;
            display_name?: string | null;
            flags?: number;
            online: boolean;
            privileged?: boolean;
            relations?: {
                _id: string;
                status:
                    | "User"
                    | "None"
                    | "Friend"
                    | "Outgoing"
                    | "Incoming"
                    | "Blocked"
                    | "BlockedOther";
            }[];
            relationship: | "User"
            | "None"
            | "Friend"
            | "Outgoing"
            | "Incoming"
            | "Blocked"
            | "BlockedOther";
            status?: | {
                presence?: "Online"
                | "Idle"
                | "Focus"
                | "Busy"
                | "Invisible"
                | null;
                text?: string | null;
            }
            | null;
            username: string;
        },
): User
| null
get a user form cache
Parameters
- resolvable:
      | string
      | {
          _id: string;
          avatar?: | {
              _id: string;
              content_type: string;
              deleted?: boolean
              | null;
              filename: string;
              message_id?: string | null;
              metadata:
                  | { type: "File" }
                  | { type: "Text" }
                  | { height: number; type: "Image"; width: number }
                  | { height: number; type: "Video"; width: number }
                  | { type: "Audio" };
              object_id?: string | null;
              reported?: boolean | null;
              server_id?: string | null;
              size: number;
              tag: string;
              user_id?: string | null;
          }
          | null;
          badges?: number;
          bot?: { owner: string }
          | null;
          discriminator: string;
          display_name?: string | null;
          flags?: number;
          online: boolean;
          privileged?: boolean;
          relations?: {
              _id: string;
              status:
                  | "User"
                  | "None"
                  | "Friend"
                  | "Outgoing"
                  | "Incoming"
                  | "Blocked"
                  | "BlockedOther";
          }[];
          relationship: | "User"
          | "None"
          | "Friend"
          | "Outgoing"
          | "Incoming"
          | "Blocked"
          | "BlockedOther";
          status?: | {
              presence?: "Online"
              | "Idle"
              | "Focus"
              | "Busy"
              | "Invisible"
              | null;
              text?: string | null;
          }
          | null;
          username: string;
      }
  The user to resolve
  - string
  - {
        _id: string;
        avatar?:
            | {
                _id: string;
                content_type: string;
                deleted?: boolean
                | null;
                filename: string;
                message_id?: string | null;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: string | null;
                reported?: boolean | null;
                server_id?: string | null;
                size: number;
                tag: string;
                user_id?: string | null;
            }
            | null;
        badges?: number;
        bot?: { owner: string }
        | null;
        discriminator: string;
        display_name?: string | null;
        flags?: number;
        online: boolean;
        privileged?: boolean;
        relations?: {
            _id: string;
            status:
                | "User"
                | "None"
                | "Friend"
                | "Outgoing"
                | "Incoming"
                | "Blocked"
                | "BlockedOther";
        }[];
        relationship: | "User"
        | "None"
        | "Friend"
        | "Outgoing"
        | "Incoming"
        | "Blocked"
        | "BlockedOther";
        status?: | {
            presence?: "Online"
            | "Idle"
            | "Focus"
            | "Busy"
            | "Invisible"
            | null;
            text?: string | null;
        }
        | null;
        username: string;
    }
    _id: string
    Description
    Unique Id
    
    Optionalavatar?:
        | {
            _id: string;
            content_type: string;
            deleted?: boolean
            | null;
            filename: string;
            message_id?: string | null;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: string | null;
            reported?: boolean | null;
            server_id?: string | null;
            size: number;
            tag: string;
            user_id?: string | null;
        }
        | null
    Description
    Avatar attachment
    
    Optionalbadges?: number
    Format: uint32
    
    Description
    Bitfield of user badges
    
    https://docs.rs/revolt-models/latest/revolt_models/v0/enum.UserBadges.html
    
    Optionalbot?: { owner: string } | null
    Description
    Bot information
    
    discriminator: string
    Description
    Discriminator
    
    Optionaldisplay_name?: string | null
    Description
    Display name
    
    Optionalflags?: number
    Format: uint32
    
    Description
    Enum of user flags
    
    https://docs.rs/revolt-models/latest/revolt_models/v0/enum.UserFlags.html
    
    online: boolean
    Description
    Whether this user is currently online
    
    Optionalprivileged?: boolean
    Description
    Whether this user is privileged
    
    Optionalrelations?: {
        _id: string;
        status:
            | "User"
            | "None"
            | "Friend"
            | "Outgoing"
            | "Incoming"
            | "Blocked"
            | "BlockedOther";
    }[]
    Description
    Relationships with other users
    
    relationship:
        | "User"
        | "None"
        | "Friend"
        | "Outgoing"
        | "Incoming"
        | "Blocked"
        | "BlockedOther"
    Description
    Current session user's relationship with this user
    
    Optionalstatus?:
        | {
            presence?: "Online"
            | "Idle"
            | "Focus"
            | "Busy"
            | "Invisible"
            | null;
            text?: string | null;
        }
        | null
    Description
    User's current status
    
    username: string
    Description
    Username
Returns User | null
The user or null if it cannot be resolved
Overrides BaseManager.resolve
- Defined in work/stoatbot.js/stoatbot.js/src/managers/userManager.ts:37

resolveId

resolveId(resolvable: UserResolvable): string | null
get a user id form cache
Parameters
- resolvable: UserResolvable
  The user to resolve
Returns string | null
The user id or null if it cannot be resolved
Overrides BaseManager.resolveId
- Defined in work/stoatbot.js/stoatbot.js/src/managers/userManager.ts:49

setMaxSize

setMaxSize(size: number): void
Adjust the maximum size for this manager at runtime.
Parameters
- size: number
Returns void
Inherited from BaseManager.setMaxSize
- Defined in work/stoatbot.js/stoatbot.js/src/managers/baseManager.ts:44

valueOf

valueOf(): Map<string, User>
Returns Map<string, User>
Inherited from BaseManager.valueOf
- Defined in work/stoatbot.js/stoatbot.js/src/managers/baseManager.ts:86

Class UserManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UserManager

Properties

Readonlycache

StaticdefaultMaxSize

Methods

fetch

Parameters

Returns Promise<User>

resolve

Parameters

Returns User | null

Parameters

_id: string

Description

Description

Optionalbadges?: number

Description

Optionalbot?: { owner: string } | null

Description

discriminator: string

Description

Optionaldisplay_name?: string | null

Description

Optionalflags?: number

Description

online: boolean

Description

Optionalprivileged?: boolean

Description

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

Description

relationship: | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"

Description

Optionalstatus?: | { presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible" | null; text?: string | null; } | null

Description

username: string

Description

Returns User | null

resolveId

Parameters

Returns string | null

setMaxSize

Parameters

Returns void

valueOf

Returns Map<string, User>

Settings

On This Page

`Readonly`cache

`Static`defaultMaxSize

`Optional`badges?: number

`Optional`bot?: { owner: string } | null

`Optional`display_name?: string | null

`Optional`flags?: number

`Optional`privileged?: boolean

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

relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther"

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