Class EmojiCollection

Collection of Emoji

Hierarchy

ClassCollection<Emoji, HydratedEmoji>
- EmojiCollection

Index

Constructors

constructor

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

Properties

`Private` #objects

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

`Private` #storage

#storage: ObjectStorage<HydratedEmoji> = ...

`Readonly` client

client: Client

`Readonly` getUnderlyingObject

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

Type declaration

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

`Readonly` updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedEmoji>>

Methods

create

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

Returns
Iterable

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

fetch

fetch(id: string): Promise<Emoji>
Fetch emoji by ID

Returns
Emoji
Parameters
- id: string
  
  Id
Returns Promise<Emoji>
- Defined in src/collections/EmojiCollection.ts:15

filter

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

find

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

forEach

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

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

get

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

Returns
Object
Parameters
- id: string
  
  Id
Returns undefined | Emoji
Inherited from ClassCollection.get
- Defined in src/collections/Collection.ts:137

getOrCreate

getOrCreate(id: string, data: {
    _id: string;
    animated?: boolean;
    creator_id: string;
    name: string;
    nsfw?: boolean;
    parent: {
        id: string;
        type: "Server";
    } | {
        type: "Detached";
    };
}, isNew?: boolean): Emoji
Get or create
Parameters
- id: string
  
  Id
- data: {
      _id: string;
      animated?: boolean;
      creator_id: string;
      name: string;
      nsfw?: boolean;
      parent: {
          id: string;
          type: "Server";
      } | {
          type: "Detached";
      };
  }
  
  Data
  - _id: string
    
    Description
    Unique Id
  - Optional animated?: boolean
    
    Description
    Whether the emoji is animated
  - creator_id: string
    
    Description
    Uploader user id
  - name: string
    
    Description
    Emoji name
  - Optional nsfw?: boolean
    
    Description
    Whether the emoji is marked as nsfw
  - parent: {
        id: string;
        type: "Server";
    } | {
        type: "Detached";
    }
    
    Description
    What owns this emoji
- isNew: boolean = false
  
  Whether this object is new
Returns Emoji
- Defined in src/collections/EmojiCollection.ts:28

getOrPartial

getOrPartial(id: string): undefined | Emoji
Get or return partial
Parameters
- id: string
  
  Id
Returns undefined | Emoji
- Defined in src/collections/EmojiCollection.ts:43

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

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

Returns
List

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

values

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

Returns
Iterable

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

Class EmojiCollection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns EmojiCollection

Properties

Private #objects

Private #storage

Readonly client

Readonly getUnderlyingObject

Type declaration

Parameters

id: string

Returns HydratedEmoji

Readonly updateUnderlyingObject

Methods

create

Parameters

id: string

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

instance: Emoji

context: unknown

Optional data: unknown

Returns void

delete

Parameters

id: string

Returns void

entries

Returns

Returns IterableIterator<[string, Emoji]>

fetch

Returns

Parameters

id: string

Returns Promise<Emoji>

filter

Parameters

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

Parameters

value: Emoji

key: string

Returns boolean

Returns Emoji[]

find

Parameters

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

Parameters

value: Emoji

key: string

Returns boolean

Returns undefined | Emoji

forEach

Returns

Parameters

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

Parameters

value: Emoji

key: string

map: ReactiveMap<string, Emoji>

Returns void

Returns void

get

Returns

Parameters

id: string

Returns undefined | Emoji

getOrCreate

Parameters

id: string

data: { _id: string; animated?: boolean; creator_id: string; name: string; nsfw?: boolean; parent: { id: string; type: "Server"; } | { type: "Detached"; }; }

_id: string

Description

Optional animated?: boolean

`Private` #objects

`Private` #storage

`Readonly` client

`Readonly` getUnderlyingObject

`Readonly` updateUnderlyingObject

`Optional` data: unknown

data: {
_id: string;
animated?: boolean;
creator_id: string;
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
}

`Optional` animated?: boolean

`Optional` nsfw?: boolean

parent: {
id: string;
type: "Server";
} | {
type: "Detached";
}