Class ServerMemberCollection

Collection of Server Members

Hierarchy

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

Properties

`Private` #objects

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

`Private` #storage

#storage: ObjectStorage<HydratedServerMember> = ...

`Readonly` client

client: Client

`Readonly` getUnderlyingObject

getUnderlyingObject: ((id: string) => HydratedServerMember)

Type declaration

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

`Readonly` updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedServerMember>>

Methods

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
- Optional data: 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
Iterable

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

fetch

fetch(serverId: string, userId: string): Promise<ServerMember>
Fetch server member by Id

Returns
Message
Parameters
- serverId: string
  
  Server Id
- userId: string
  
  User Id
Returns Promise<ServerMember>
- Defined in src/collections/ServerMemberCollection.ts:37

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
  - - (value: ServerMember, key: string): boolean
    - Parameters
      
      value: ServerMember
      
      key: string
      
      Returns boolean
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
  - - (value: ServerMember, key: string): boolean
    - Parameters
      
      value: ServerMember
      
      key: string
      
      Returns boolean
Returns undefined | ServerMember
Inherited from ClassCollection.find
- Defined in src/collections/Collection.ts:105

forEach

forEach(cb: ((value: ServerMember, key: string, map: ReactiveMap<string, ServerMember>) => void)): void
Execute a provided function over each key, value pair in the map

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

get

get(id: string): undefined | ServerMember
Get an existing object

Returns
Object
Parameters
- id: string
  
  Id
Returns undefined | ServerMember
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

Returns
Member
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:27

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";
        } | {
            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;
    };
    joined_at: string;
    nickname?: 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";
          } | {
              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;
      };
      joined_at: string;
      nickname?: 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
  - 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
  - joined_at: string
    
    Description
    Time at which this user joined the server
  - Optional nickname?: null | string
    
    Description
    Member's nickname
  - Optional roles?: string[]
    
    Description
    Member's roles
  - Optional timeout?: null | string
    
    Description
    Timestamp this member is timed out until
Returns ServerMember
- Defined in src/collections/ServerMemberCollection.ts:53

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

has

has(id: string): boolean
Check whether an id exists in the Collection

Returns
Whether it exists
Parameters
- id: string
  
  Id
Returns boolean
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

Returns
Whether it exists
Parameters
- id: {
  server: string;
  user: string;
  }
  
  Id
  - server: string
    
    Description
    Server Id
  - user: string
    
    Description
    User Id
Returns boolean
- Defined in src/collections/ServerMemberCollection.ts:18

isPartial

isPartial(id: string): boolean
Check whether an object is partially defined

Returns
Whether it is a partial
Parameters
- id: string
  
  Id
Returns boolean
Inherited from ClassCollection.isPartial
- Defined in src/collections/Collection.ts:183

keys

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

Returns
Iterable

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

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
  - - (value: ServerMember, key: string): O
    - Parameters
      
      value: ServerMember
      
      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
Size

Returns number
Inherited from ClassCollection.size
- Defined in src/collections/Collection.ts:191

toList

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

Returns
List

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

values

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

Returns
Iterable

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

Class ServerMemberCollection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns ServerMemberCollection

Properties

Private #objects

Private #storage

Readonly client

Readonly getUnderlyingObject

Type declaration

Parameters

id: string

Returns HydratedServerMember

Readonly updateUnderlyingObject

Methods

create

Parameters

id: string

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

instance: ServerMember

context: unknown

Optional data: unknown

Returns void

delete

Parameters

id: string

Returns void

entries

Returns

Returns IterableIterator<[string, ServerMember]>

fetch

Returns

Parameters

serverId: string

userId: string

Returns Promise<ServerMember>

filter

Parameters

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

Parameters

value: ServerMember

key: string

Returns boolean

Returns ServerMember[]

find

Parameters

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

Parameters

value: ServerMember

key: string

Returns boolean

Returns undefined | ServerMember

forEach

Returns

Parameters

cb: ((value: ServerMember, key: string, map: ReactiveMap<string, ServerMember>) => void)

Parameters

value: ServerMember

key: string

map: ReactiveMap<string, ServerMember>

Returns void

Returns void

get

Returns

Parameters

id: string

Returns undefined | ServerMember

getByKey

Returns

Parameters

id: { server: string; user: string; }

server: string

Description

`Private` #objects

`Private` #storage

`Readonly` client

`Readonly` getUnderlyingObject

`Readonly` updateUnderlyingObject

`Optional` data: unknown

id: {
server: string;
user: string;
}

id: {
server: string;
user: string;
}

_id: {
server: string;
user: string;
}

`Optional` nickname?: null | string

`Optional` roles?: string[]

`Optional` timeout?: null | string

id: {
server: string;
user: string;
}

id: {
server: string;
user: string;
}