Class UserCollection

Collection of Users

Hierarchy (View Summary)

ClassCollection<User, HydratedUser>
- UserCollection

Index

Constructors

constructor

new UserCollection(client: Client): UserCollection
Construct User collection
Parameters
- client: Client
Returns UserCollection
Overrides ClassCollection.constructor
- Defined in src/collections/UserCollection.ts:16

Properties

`Readonly`client

client: Client

`Readonly`getUnderlyingObject

getUnderlyingObject: (id: string) => HydratedUser

`Readonly`updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedUser>>

Methods

`Protected`add

add(id: string, instance: User, hydrated: HydratedUser): void
Add a previously hydrated object to the collection
Parameters
- id: string
  Id
- instance: User
  Instance
- hydrated: HydratedUser
  Hydrated
Returns void
Inherited from ClassCollection.add
- Defined in src/collections/Collection.ts:196

addHydratedUser

addHydratedUser(user: HydratedUser): User
Add a pre-hydrated user to this collection.
Parameters
- user: HydratedUser
  A hydrated user
Returns User
The user instance
- Defined in src/collections/UserCollection.ts:95

create

create(
    id: string,
    type:
        | "user"
        | "server"
        | "channel"
        | "bot"
        | "channelUnread"
        | "channelWebhook"
        | "emoji"
        | "message"
        | "serverMember"
        | "session",
    instance: User,
    context: unknown,
    data?: unknown,
): 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: User
  Instance
- context: unknown
  Context
- Optionaldata: unknown
  Data
Returns void
Inherited from ClassCollection.create
- Defined in src/collections/Collection.ts:167

delete

delete(id: string): 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, User]>
Iterable of key, value pairs in the map

Returns IterableIterator<[string, User]>
Iterable
Inherited from ClassCollection.entries
- Defined in src/collections/Collection.ts:238

fetch

fetch(id: string): Promise<User>
Fetch user by ID
Parameters
- id: string
  Id
Returns Promise<User>
User
- Defined in src/collections/UserCollection.ts:34

filter

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

find

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

forEach

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

get

get(id: string): undefined | User
Get an existing object
Parameters
- id: string
  Id
Returns undefined | User
Object
Inherited from ClassCollection.get
- Defined in src/collections/Collection.ts:137

getOrCreate

getOrCreate(
    id: string,
    data: {
        _id: string;
        avatar?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | {
                        animated?: null | boolean;
                        height: number;
                        thumbhash?: null | 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;
            };
        badges?: number;
        bot?: null
        | { owner: string };
        discriminator: string;
        display_name?: null | string;
        flags?: number;
        online: boolean;
        privileged?: boolean;
        pronouns?: null | string;
        relations?: {
            _id: string;
            status:
                | "User"
                | "None"
                | "Friend"
                | "Outgoing"
                | "Incoming"
                | "Blocked"
                | "BlockedOther";
        }[];
        relationship: | "User"
        | "None"
        | "Friend"
        | "Outgoing"
        | "Incoming"
        | "Blocked"
        | "BlockedOther";
        status?: | null
        | {
            presence?: null
            | "Online"
            | "Idle"
            | "Focus"
            | "Busy"
            | "Invisible";
            text?: null | string;
        };
        username: string;
    },
): User
Get or create
Parameters
- id: string
  Id
- data: {
      _id: string;
      avatar?:
          | null
          | {
              _id: string;
              content_type: string;
              deleted?: null
              | boolean;
              filename: string;
              message_id?: null | string;
              metadata:
                  | { type: "File" }
                  | { type: "Text" }
                  | {
                      animated?: null | boolean;
                      height: number;
                      thumbhash?: null | 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;
          };
      badges?: number;
      bot?: null
      | { owner: string };
      discriminator: string;
      display_name?: null | string;
      flags?: number;
      online: boolean;
      privileged?: boolean;
      pronouns?: null | string;
      relations?: {
          _id: string;
          status:
              | "User"
              | "None"
              | "Friend"
              | "Outgoing"
              | "Incoming"
              | "Blocked"
              | "BlockedOther";
      }[];
      relationship: | "User"
      | "None"
      | "Friend"
      | "Outgoing"
      | "Incoming"
      | "Blocked"
      | "BlockedOther";
      status?: | null
      | {
          presence?: null
          | "Online"
          | "Idle"
          | "Focus"
          | "Busy"
          | "Invisible";
          text?: null | string;
      };
      username: string;
  }
  Data
  - _id: string
    Description
    Unique Id
  - Optionalavatar?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | {
                    animated?: null | boolean;
                    height: number;
                    thumbhash?: null | 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
    Avatar attachment
  - Optionalbadges?: number
    Format: uint32
    
    Description
    Bitfield of user badges
    
    https://docs.rs/revolt-models/latest/revolt_models/v0/enum.UserBadges.html
  - Optionalbot?: null | { owner: string }
    Description
    Bot information
  - discriminator: string
    Description
    Discriminator
  - Optionaldisplay_name?: null | string
    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
  - Optionalpronouns?: null | string
    Description
    User's pronouns
  - 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?:
        | null
        | {
            presence?: null
            | "Online"
            | "Idle"
            | "Focus"
            | "Busy"
            | "Invisible";
            text?: null | string;
        }
    Description
    User's current status
  - username: string
    Description
    Username
Returns User
- Defined in src/collections/UserCollection.ts:46

getOrPartial

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

has

has(id: string): 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

`Protected`hydrate

hydrate(
    type:
        | "user"
        | "server"
        | "channel"
        | "bot"
        | "channelUnread"
        | "channelWebhook"
        | "emoji"
        | "message"
        | "serverMember"
        | "session",
    context: unknown,
    data: object,
): HydratedUser
Hydrate a new instance of an object. This function does not add the object to the collection.
Parameters
- type:
      | "user"
      | "server"
      | "channel"
      | "bot"
      | "channelUnread"
      | "channelWebhook"
      | "emoji"
      | "message"
      | "serverMember"
      | "session"
  Type
- context: unknown
  Context
- data: object
  Data
Returns HydratedUser
Inherited from ClassCollection.hydrate
- Defined in src/collections/Collection.ts:186

hydrateIfNotHas

hydrateIfNotHas(
    id: string,
    data: {
        _id: string;
        avatar?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | {
                        animated?: null | boolean;
                        height: number;
                        thumbhash?: null | 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;
            };
        badges?: number;
        bot?: null
        | { owner: string };
        discriminator: string;
        display_name?: null | string;
        flags?: number;
        online: boolean;
        privileged?: boolean;
        pronouns?: null | string;
        relations?: {
            _id: string;
            status:
                | "User"
                | "None"
                | "Friend"
                | "Outgoing"
                | "Incoming"
                | "Blocked"
                | "BlockedOther";
        }[];
        relationship: | "User"
        | "None"
        | "Friend"
        | "Outgoing"
        | "Incoming"
        | "Blocked"
        | "BlockedOther";
        status?: | null
        | {
            presence?: null
            | "Online"
            | "Idle"
            | "Focus"
            | "Busy"
            | "Invisible";
            text?: null | string;
        };
        username: string;
    },
): undefined
| HydratedUser
Hydrate a new user if it is not in the collection yet. This function does not add the user to the store, make sure you call addHydratedUser afterwards. This function is particularly useful when adding many users asynchronously. See Server.syncMembers for an example of this in use.
Parameters
- id: string
  The ID of the user
- data: {
      _id: string;
      avatar?:
          | null
          | {
              _id: string;
              content_type: string;
              deleted?: null
              | boolean;
              filename: string;
              message_id?: null | string;
              metadata:
                  | { type: "File" }
                  | { type: "Text" }
                  | {
                      animated?: null | boolean;
                      height: number;
                      thumbhash?: null | 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;
          };
      badges?: number;
      bot?: null
      | { owner: string };
      discriminator: string;
      display_name?: null | string;
      flags?: number;
      online: boolean;
      privileged?: boolean;
      pronouns?: null | string;
      relations?: {
          _id: string;
          status:
              | "User"
              | "None"
              | "Friend"
              | "Outgoing"
              | "Incoming"
              | "Blocked"
              | "BlockedOther";
      }[];
      relationship: | "User"
      | "None"
      | "Friend"
      | "Outgoing"
      | "Incoming"
      | "Blocked"
      | "BlockedOther";
      status?: | null
      | {
          presence?: null
          | "Online"
          | "Idle"
          | "Focus"
          | "Busy"
          | "Invisible";
          text?: null | string;
      };
      username: string;
  }
  The API object for a user
  - _id: string
    Description
    Unique Id
  - Optionalavatar?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | {
                    animated?: null | boolean;
                    height: number;
                    thumbhash?: null | 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
    Avatar attachment
  - Optionalbadges?: number
    Format: uint32
    
    Description
    Bitfield of user badges
    
    https://docs.rs/revolt-models/latest/revolt_models/v0/enum.UserBadges.html
  - Optionalbot?: null | { owner: string }
    Description
    Bot information
  - discriminator: string
    Description
    Discriminator
  - Optionaldisplay_name?: null | string
    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
  - Optionalpronouns?: null | string
    Description
    User's pronouns
  - 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?:
        | null
        | {
            presence?: null
            | "Online"
            | "Idle"
            | "Focus"
            | "Busy"
            | "Invisible";
            text?: null | string;
        }
    Description
    User's current status
  - username: string
    Description
    Username
Returns undefined | HydratedUser
The HydratedUser, or undefined if the user is in the collection
- Defined in src/collections/UserCollection.ts:82

isPartial

isPartial(id: string): 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:206

keys

keys(): IterableIterator<string>
Iterable of keys in the map

Returns IterableIterator<string>
Iterable
Inherited from ClassCollection.keys
- Defined in src/collections/Collection.ts:222

map

map<O>(cb: (value: User, key: string) => O): O[]
Map the collection using a given callback
Type Parameters
- O
Parameters
- cb: (value: User, key: string) => O
  Callback
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:214

toList

toList(): User[]
List of values in the map

Returns User[]
List
Inherited from ClassCollection.toList
- Defined in src/collections/Collection.ts:69

values

values(): IterableIterator<User>
Iterable of values in the map

Returns IterableIterator<User>
Iterable
Inherited from ClassCollection.values
- Defined in src/collections/Collection.ts:230

Class UserCollection

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UserCollection

Properties

Readonlyclient

ReadonlygetUnderlyingObject

ReadonlyupdateUnderlyingObject

Methods

Protectedadd

Parameters

Returns void

addHydratedUser

Parameters

Returns User

create

Parameters

Returns void

delete

Parameters

Returns void

entries

Returns IterableIterator<[string, User]>

fetch

Parameters

Returns Promise<User>

filter

Parameters

Returns User[]

find

Parameters

Returns undefined | User

forEach

Parameters

Returns void

get

Parameters

Returns undefined | User

getOrCreate

Parameters

_id: string

Description

Description

Optionalbadges?: number

Description

Optionalbot?: null | { owner: string }

Description

discriminator: string

Description

Optionaldisplay_name?: null | string

Description

Optionalflags?: number

Description

online: boolean

Description

Optionalprivileged?: boolean

Description

Optionalpronouns?: null | string

Description

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

Description

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

Description

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

Description

username: string

Description

Returns User

getOrPartial

Parameters

Returns undefined | User

has

Parameters

Returns boolean

`Readonly`client

`Readonly`getUnderlyingObject

`Readonly`updateUnderlyingObject

`Protected`add

`Optional`badges?: number

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

`Optional`display_name?: null | string

`Optional`flags?: number

`Optional`privileged?: boolean

`Optional`pronouns?: null | string

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

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

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

`Protected`hydrate

`Optional`badges?: number

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

`Optional`display_name?: null | string

`Optional`flags?: number

`Optional`privileged?: boolean

`Optional`pronouns?: null | string

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

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

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