Class EmojiCollection

Collection of Emoji

Hierarchy (View Summary)

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

Properties

`Readonly`client

client: Client

`Readonly`getUnderlyingObject

getUnderlyingObject: (id: string) => HydratedEmoji

`Readonly`updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedEmoji>>

Methods

`Protected`add

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

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
- 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, Emoji]>
Iterable of key, value pairs in the map

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

fetch

fetch(id: string): Promise<Emoji>
Fetch emoji by ID
Parameters
- id: string
  Id
Returns Promise<Emoji>
Emoji
- Defined in src/collections/EmojiCollection.ts:17

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
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
Returns undefined | Emoji
Inherited from ClassCollection.find
- Defined in src/collections/Collection.ts:105

forEach

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

get

get(id: string): undefined | Emoji
Get an existing object
Parameters
- id: string
  Id
Returns undefined | Emoji
Object
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
  - Optionalanimated?: boolean
    Description
    Whether the emoji is animated
  - creator_id: string
    Description
    Uploader user id
  - name: string
    Description
    Emoji name
  - Optionalnsfw?: 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:30

getOrPartial

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

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,
): HydratedEmoji
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 HydratedEmoji
Inherited from ClassCollection.hydrate
- Defined in src/collections/Collection.ts:186

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

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

values

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

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

Class EmojiCollection

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EmojiCollection

Properties

Readonlyclient

ReadonlygetUnderlyingObject

ReadonlyupdateUnderlyingObject

Methods

Protectedadd

Parameters

Returns void

create

Parameters

Returns void

delete

Parameters

Returns void

entries

Returns IterableIterator<[string, Emoji]>

fetch

Parameters

Returns Promise<Emoji>

filter

Parameters

Returns Emoji[]

find

Parameters

Returns undefined | Emoji

forEach

Parameters

Returns void

get

Parameters

Returns undefined | Emoji

getOrCreate

Parameters

_id: string

Description

Optionalanimated?: boolean

Description

creator_id: string

Description

name: string

Description

Optionalnsfw?: boolean

Description

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

Description

Returns Emoji

getOrPartial

Parameters

Returns undefined | Emoji

has

Parameters

Returns boolean

Protectedhydrate

Parameters

Returns HydratedEmoji

isPartial

Parameters

Returns boolean

keys

Returns IterableIterator<string>

map

Type Parameters

Parameters

Returns O[]

size

Returns number

toList

Returns Emoji[]

values

Returns IterableIterator<Emoji>

`Readonly`client

`Readonly`getUnderlyingObject

`Readonly`updateUnderlyingObject

`Protected`add

`Optional`animated?: boolean

`Optional`nsfw?: boolean

`Protected`hydrate