Class UserCollection

Collection of Users

Hierarchy

ClassCollection<User, HydratedUser>
- UserCollection

Index

Constructors

constructor

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

Properties

`Private` #objects

#objects: ReactiveMap<string, User> = ...

`Private` #storage

#storage: ObjectStorage<HydratedUser> = ...

`Readonly` client

client: Client

`Readonly` getUnderlyingObject

getUnderlyingObject: ((id) => HydratedUser)

Type declaration

- (id): HydratedUser
- Parameters
  - id: string
  Returns HydratedUser

`Readonly` updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedUser>>

Methods

create

create(id, type, instance, context, data?): 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
- Optional data: unknown
  
  Data
Returns void
Inherited from ClassCollection.create
- Defined in src/collections/Collection.ts:167

delete

delete(id): 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:215

fetch

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

filter

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

find

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

forEach

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

get

get(id): 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, data): 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";
          } | {
              height: 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;
      relations?: {
          _id: string;
          status: "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther";
      }[];
      relationship: "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther";
      status?: null | {
          presence?: null | "Invisible" | "Online" | "Idle" | "Focus" | "Busy";
          text?: null | string;
      };
      username: string;
  }
  
  Data
  - _id: string
    
    Description
    Unique Id
  - Optional avatar?: null | {
        _id: string;
        content_type: string;
        deleted?: null | boolean;
        filename: string;
        message_id?: null | string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: 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
  - Optional badges?: number
    
    Format: uint32
    
    Description
    Bitfield of user badges
    
    https://docs.rs/revolt-models/latest/revolt_models/v0/enum.UserBadges.html
  - Optional bot?: null | {
    owner: string;
    }
    
    Description
    Bot information
  - discriminator: string
    
    Description
    Discriminator
  - Optional display_name?: null | string
    
    Description
    Display name
  - Optional flags?: 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
  - Optional privileged?: boolean
    
    Description
    Whether this user is privileged
  - Optional relations?: {
    _id: string;
    status: "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther";
    }[]
    
    Description
    Relationships with other users
  - relationship: "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"
    
    Description
    Current session user's relationship with this user
  - Optional status?: null | {
    presence?: null | "Invisible" | "Online" | "Idle" | "Focus" | "Busy";
    text?: null | string;
    }
    
    Description
    User's current status
  - username: string
    
    Description
    Username
Returns User
- Defined in src/collections/UserCollection.ts:44

getOrPartial

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

has

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

isPartial

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

keys

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

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

map

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

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

Class UserCollection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns UserCollection

Properties

Private #objects

Private #storage

Readonly client

Readonly getUnderlyingObject

Type declaration

Parameters

id: string

Returns HydratedUser

Readonly updateUnderlyingObject

Methods

create

Parameters

id: string

type: "user" | "server" | "channel" | "bot" | "channelUnread" | "channelWebhook" | "emoji" | "message" | "serverMember" | "session"

instance: User

context: unknown

Optional data: unknown

Returns void

delete

Parameters

id: string

Returns void

entries

Returns IterableIterator<[string, User]>

fetch

Parameters

id: string

Returns Promise<User>

filter

Parameters

predicate: ((value, key) => boolean)

Parameters

value: User

key: string

Returns boolean

Returns User[]

find

Parameters

predicate: ((value, key) => boolean)

Parameters

value: User

key: string

Returns boolean

Returns undefined | User

forEach

Parameters

cb: ((value, key, map) => void)

Parameters

value: User

key: string

map: ReactiveMap<string, User>

Returns void

Returns void

get

Parameters

id: string

Returns undefined | User

getOrCreate

Parameters

id: string

_id: string

Description

Description

Optional badges?: number

Description

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

Description

discriminator: string

`Private` #objects

`Private` #storage

`Readonly` client

`Readonly` getUnderlyingObject

`Readonly` updateUnderlyingObject

`Optional` data: unknown

`Optional` badges?: number

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

`Optional` display_name?: null | string

`Optional` flags?: number

`Optional` privileged?: boolean

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

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