Class ServerMemberCollection

Collection of Server Members

Hierarchy (View Summary)

ClassCollection<ServerMember, HydratedServerMember>
- ServerMemberCollection

Index

Constructors

constructor

new ServerMemberCollection(client: Client): ServerMemberCollection
Create generic class collection
Parameters
- client: Client
  Client
Returns ServerMemberCollection
Inherited from ClassCollection.constructor
- Defined in src/collections/Collection.ts:262

Properties

`Readonly`client

client: Client

`Readonly`getUnderlyingObject

getUnderlyingObject: (id: string) => HydratedServerMember

`Readonly`updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedServerMember>>

Methods

`Protected`add

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

addHydratedServerMember

addHydratedServerMember(member: HydratedServerMember): ServerMember
Add a pre-hydrated server member to this collection.
Parameters
- member: HydratedServerMember
Returns ServerMember
The server member instance
- Defined in src/collections/ServerMemberCollection.ts:127

create

create(
    id: string,
    type:
        | "user"
        | "server"
        | "channel"
        | "bot"
        | "channelUnread"
        | "channelWebhook"
        | "emoji"
        | "message"
        | "serverMember"
        | "session",
    instance: ServerMember,
    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: ServerMember
  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, ServerMember]>
Iterable of key, value pairs in the map

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

fetch

fetch(serverId: string, userId: string): Promise<ServerMember>
Fetch server member by Id
Parameters
- serverId: string
  Server Id
- userId: string
  User Id
Returns Promise<ServerMember>
Message
- Defined in src/collections/ServerMemberCollection.ts:48

filter

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

find

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

forEach

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

get

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

getByKey

getByKey(id: { server: string; user: string }): undefined | ServerMember
Get member by composite key
Parameters
- id: { server: string; user: string }
  Id
  - server: string
    Description
    Server Id
  - user: string
    Description
    User Id
Returns undefined | ServerMember
Member
- Defined in src/collections/ServerMemberCollection.ts:29

getOrCreate

getOrCreate(
    id: { server: string; user: string },
    data: {
        _id: { server: string; user: 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;
            };
        can_publish?: boolean;
        can_receive?: boolean;
        joined_at: string;
        nickname?: null
        | string;
        pronouns?: null | string;
        roles?: string[];
        timeout?: null | string;
    },
): ServerMember
Get or create
Parameters
- id: { server: string; user: string }
  Id
  - server: string
    Description
    Server Id
  - user: string
    Description
    User Id
- data: {
      _id: { server: string; user: 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;
          };
      can_publish?: boolean;
      can_receive?: boolean;
      joined_at: string;
      nickname?: null
      | string;
      pronouns?: null | string;
      roles?: string[];
      timeout?: null | string;
  }
  Data
  - _id: { server: string; user: string }
    Description
    Unique member id
    
    server: string
    Description
    Server Id
    
    user: string
    Description
    User 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
  - Optionalcan_publish?: boolean
    Description
    Whether the member is server-wide voice muted
  - Optionalcan_receive?: boolean
    Description
    Whether the member is server-wide voice deafened
  - joined_at: string
    Description
    Time at which this user joined the server
  - Optionalnickname?: null | string
    Description
    Member's nickname
  - Optionalpronouns?: null | string
    Description
    Member's pronouns
  - Optionalroles?: string[]
    Description
    Member's roles
  - Optionaltimeout?: null | string
    Description
    Timestamp this member is timed out until
Returns ServerMember
- Defined in src/collections/ServerMemberCollection.ts:68

getOrPartial

getOrPartial(id: { server: string; user: string }): undefined | ServerMember
Get or return partial
Parameters
- id: { server: string; user: string }
  Id
  - server: string
    Description
    Server Id
  - user: string
    Description
    User Id
Returns undefined | ServerMember
- Defined in src/collections/ServerMemberCollection.ts:88

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

hasByKey

hasByKey(id: { server: string; user: string }): boolean
Check if member exists by composite key
Parameters
- id: { server: string; user: string }
  Id
  - server: string
    Description
    Server Id
  - user: string
    Description
    User Id
Returns boolean
Whether it exists
- Defined in src/collections/ServerMemberCollection.ts:20

`Protected`hydrate

hydrate(
    type:
        | "user"
        | "server"
        | "channel"
        | "bot"
        | "channelUnread"
        | "channelWebhook"
        | "emoji"
        | "message"
        | "serverMember"
        | "session",
    context: unknown,
    data: object,
): HydratedServerMember
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 HydratedServerMember
Inherited from ClassCollection.hydrate
- Defined in src/collections/Collection.ts:186

hydrateIfNotHas

hydrateIfNotHas(
    id: { server: string; user: string },
    data: {
        _id: { server: string; user: 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;
            };
        can_publish?: boolean;
        can_receive?: boolean;
        joined_at: string;
        nickname?: null
        | string;
        pronouns?: null | string;
        roles?: string[];
        timeout?: null | string;
    },
): undefined
| HydratedServerMember
Hydrate a new server member if it is not in the collection yet. This function does not add the server member to the store, make sure you call addHydratedServerMember afterwards. This function is particularly useful when adding many server members asynchronously. See Server.syncMembers for an example of this in use.
Parameters
- id: { server: string; user: string }
  The ID of the server member
  - server: string
    Description
    Server Id
  - user: string
    Description
    User Id
- data: {
      _id: { server: string; user: 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;
          };
      can_publish?: boolean;
      can_receive?: boolean;
      joined_at: string;
      nickname?: null
      | string;
      pronouns?: null | string;
      roles?: string[];
      timeout?: null | string;
  }
  The API object for a server member
  - _id: { server: string; user: string }
    Description
    Unique member id
    
    server: string
    Description
    Server Id
    
    user: string
    Description
    User 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
  - Optionalcan_publish?: boolean
    Description
    Whether the member is server-wide voice muted
  - Optionalcan_receive?: boolean
    Description
    Whether the member is server-wide voice deafened
  - joined_at: string
    Description
    Time at which this user joined the server
  - Optionalnickname?: null | string
    Description
    Member's nickname
  - Optionalpronouns?: null | string
    Description
    Member's pronouns
  - Optionalroles?: string[]
    Description
    Member's roles
  - Optionaltimeout?: null | string
    Description
    Timestamp this member is timed out until
Returns undefined | HydratedServerMember
The HydratedServerMember, or undefined if the user is in the collection
- Defined in src/collections/ServerMemberCollection.ts:111

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

isPartialByKey

isPartialByKey(id: { server: string; user: string }): boolean
check partial status by composite key
Parameters
- id: { server: string; user: string }
  Id
  - server: string
    Description
    Server Id
  - user: string
    Description
    User Id
Returns boolean
Member
- Defined in src/collections/ServerMemberCollection.ts:38

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: ServerMember, key: string) => O): O[]
Map the collection using a given callback
Type Parameters
- O
Parameters
- cb: (value: ServerMember, 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(): ServerMember[]
List of values in the map

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

values

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

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

Class ServerMemberCollection

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ServerMemberCollection

Properties

Readonlyclient

ReadonlygetUnderlyingObject

ReadonlyupdateUnderlyingObject

Methods

Protectedadd

Parameters

Returns void

addHydratedServerMember

Parameters

Returns ServerMember

create

Parameters

Returns void

delete

Parameters

Returns void

entries

Returns IterableIterator<[string, ServerMember]>

fetch

Parameters

Returns Promise<ServerMember>

filter

Parameters

Returns ServerMember[]

find

Parameters

Returns undefined | ServerMember

forEach

Parameters

Returns void

get

Parameters

Returns undefined | ServerMember

getByKey

Parameters

server: string

Description

user: string

Description

Returns undefined | ServerMember

getOrCreate

Parameters

server: string

Description

user: string

Description

_id: { server: string; user: string }

Description

server: string

Description

user: string

Description

Description

Optionalcan_publish?: boolean

Description

Optionalcan_receive?: boolean

Description

joined_at: string

Description

Optionalnickname?: null | string

Description

Optionalpronouns?: null | string

Description

Optionalroles?: string[]

Description

Optionaltimeout?: null | string

Description

Returns ServerMember

getOrPartial

`Readonly`client

`Readonly`getUnderlyingObject

`Readonly`updateUnderlyingObject

`Protected`add

`Optional`can_publish?: boolean

`Optional`can_receive?: boolean

`Optional`nickname?: null | string

`Optional`pronouns?: null | string

`Optional`roles?: string[]

`Optional`timeout?: null | string

`Protected`hydrate

`Optional`can_publish?: boolean

`Optional`can_receive?: boolean

`Optional`nickname?: null | string

`Optional`pronouns?: null | string

`Optional`roles?: string[]

`Optional`timeout?: null | string