Class EmojiManager

Hierarchy

BaseManager<Emoji>
- EmojiManager

Index

Constructors

constructor

new EmojiManager(client: Client): EmojiManager
Parameters
- client: Client
Returns EmojiManager
Overrides BaseManager<Emoji>.constructor
- Defined in core/src/managers/EmojiManager.ts:8

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Private` client

client: Client

`Private` orderCache

orderCache: Emoji[] = []

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Accessors

known

get known(): Emoji[]
Returns Emoji[]
- Defined in core/src/managers/EmojiManager.ts:19

ordered

get ordered(): Emoji[]
Returns Emoji[]
- Defined in core/src/managers/EmojiManager.ts:14

Methods

[iterator]

[iterator](): IterableIterator<[string, Emoji]>
Returns an iterable of entries in the map.

Returns IterableIterator<[string, Emoji]>
Inherited from BaseManager.__@iterator@11
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

clear

clear(): void
Returns void
Inherited from BaseManager.clear
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:21

construct

construct(data: {
    _id: string;
    animated?: boolean;
    creator_id: string;
    name: string;
    nsfw?: boolean;
    parent: {
        id: string;
        type: "Server";
    } | {
        type: "Detached";
    };
}): Emoji
Parameters
- data: {
      _id: string;
      animated?: boolean;
      creator_id: string;
      name: string;
      nsfw?: boolean;
      parent: {
          id: string;
          type: "Server";
      } | {
          type: "Detached";
      };
  }
  - _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
Returns Emoji
- Defined in core/src/managers/EmojiManager.ts:23

create

create(server: Server, attachmentID: string, name: string): Promise<Emoji>
Create an emoji. Attachment bucket for ID must be emojis.
Parameters
- server: Server
- attachmentID: string
- name: string
Returns Promise<Emoji>
- Defined in core/src/managers/EmojiManager.ts:39

delete

delete(key: string): boolean
Parameters
- key: string
Returns boolean
Inherited from BaseManager.delete
- Defined in core/src/managers/BaseManager.ts:14

entries

entries(): IterableIterator<[string, Emoji]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[string, Emoji]>
Inherited from BaseManager.entries
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

fetch

fetch(id: string, fetchNew?: boolean): Promise<Emoji>
Parameters
- id: string
- fetchNew: boolean = false
Returns Promise<Emoji>
- Defined in core/src/managers/EmojiManager.ts:33

filter

filter(...d: [predicate: ((value: Emoji, index: number, array: Emoji[]) => unknown), thisArg?: any]): Emoji[]
Parameters
- Rest ...d: [predicate: ((value: Emoji, index: number, array: Emoji[]) => unknown), thisArg?: any]
Returns Emoji[]
Inherited from BaseManager.filter
- Defined in core/src/managers/BaseManager.ts:27

find

find(...d: [predicate: ((value: Emoji, index: number, obj: Emoji[]) => unknown), thisArg?: any]): Emoji
Parameters
- Rest ...d: [predicate: ((value: Emoji, index: number, obj: Emoji[]) => unknown), thisArg?: any]
Returns Emoji
Inherited from BaseManager.find
- Defined in core/src/managers/BaseManager.ts:24

fireUpdate

fireUpdate(updated?: Emoji[]): void
Runs all of the callbacks for this emitter. (meant to run when an update occurs)
Parameters
- Optional updated: Emoji[]
  
  The objects that caused this update.
Returns void
Inherited from BaseManager.fireUpdate
- Defined in core/src/utils/MiniEmitter.ts:67

forEach

forEach(callbackfn: ((value: Emoji, key: string, map: Map<string, Emoji>) => void), thisArg?: any): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value: Emoji, key: string, map: Map<string, Emoji>) => void)
  - - (value: Emoji, key: string, map: Map<string, Emoji>): void
    - Parameters
      
      value: Emoji
      
      key: string
      
      map: Map<string, Emoji>
      
      Returns void
- Optional thisArg: any
Returns void
Inherited from BaseManager.forEach
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:29

get

get(key: string): Emoji
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

Returns
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Parameters
- key: string
Returns Emoji
Inherited from BaseManager.get
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:34

has

has(key: string): boolean
Returns
boolean indicating whether an element with the specified key exists or not.
Parameters
- key: string
Returns boolean
Inherited from BaseManager.has
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:38

items

items(): Emoji[]
Returns Emoji[]
Inherited from BaseManager.items
- Defined in core/src/managers/BaseManager.ts:20

keys

keys(): IterableIterator<string>
Returns an iterable of keys in the map

Returns IterableIterator<string>
Inherited from BaseManager.keys
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

map

map<U>(callbackfn: ((value: Emoji, index: number, array: Emoji[]) => U)): U[]
Type Parameters
- U
Parameters
- callbackfn: ((value: Emoji, index: number, array: Emoji[]) => U)
  - - (value: Emoji, index: number, array: Emoji[]): U
    - Parameters
      
      value: Emoji
      
      index: number
      
      array: Emoji[]
      
      Returns U
Returns U[]
Inherited from BaseManager.map
- Defined in core/src/managers/BaseManager.ts:30

offUpdate

offUpdate(callback: MiniEmitterCallback<Emoji>): EmojiManager
Stops listening for Map updates.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<Emoji>
  
  The callback to stop listening for updates on.
Returns EmojiManager
Inherited from BaseManager.offUpdate
- Defined in core/src/utils/MiniEmitter.ts:58

onUpdate

onUpdate(callback: MiniEmitterCallback<Emoji>): EmojiManager
Listen for an update to this Map.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<Emoji>
  
  The callback to run when an update occurs.
Returns EmojiManager
Inherited from BaseManager.onUpdate
- Defined in core/src/utils/MiniEmitter.ts:49

set

set(key: string, value: Emoji): EmojiManager
Parameters
- key: string
- value: Emoji
Returns EmojiManager
Inherited from BaseManager.set
- Defined in core/src/managers/BaseManager.ts:9

sort

sort(...d: [compareFn?: ((a: Emoji, b: Emoji) => number)]): Emoji[]
Parameters
- Rest ...d: [compareFn?: ((a: Emoji, b: Emoji) => number)]
Returns Emoji[]
Inherited from BaseManager.sort
- Defined in core/src/managers/BaseManager.ts:33

values

values(): IterableIterator<Emoji>
Returns an iterable of values in the map

Returns IterableIterator<Emoji>
Inherited from BaseManager.values
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

Class EmojiManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

Returns EmojiManager

Properties

Readonly [toStringTag]

Private client

Private orderCache

Readonly size

Returns

Static Readonly [species]

Accessors

known

Returns Emoji[]

ordered

Returns Emoji[]

Methods

[iterator]

Returns IterableIterator<[string, Emoji]>

clear

Returns void

construct

Parameters

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

Description

creator_id: string

Description

name: string

Description

Optional nsfw?: boolean

Description

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

Description

Returns Emoji

create

Parameters

server: Server

attachmentID: string

name: string

Returns Promise<Emoji>

delete

Parameters

key: string

Returns boolean

entries

Returns IterableIterator<[string, Emoji]>

fetch

Parameters

id: string

fetchNew: boolean = false

Returns Promise<Emoji>

filter

Parameters

Rest ...d: [predicate: ((value: Emoji, index: number, array: Emoji[]) => unknown), thisArg?: any]

Returns Emoji[]

find

Parameters

Rest ...d: [predicate: ((value: Emoji, index: number, obj: Emoji[]) => unknown), thisArg?: any]

Returns Emoji

fireUpdate

Parameters

Optional updated: Emoji[]

Returns void

forEach

Parameters

callbackfn: ((value: Emoji, key: string, map: Map<string, Emoji>) => void)

Parameters

value: Emoji

key: string

`Readonly` [toStringTag]

`Private` client

`Private` orderCache

`Readonly` size

`Static` `Readonly` [species]

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";
}

`Rest` ...d: [predicate: ((value: Emoji, index: number, array: Emoji[]) => unknown), thisArg?: any]

`Rest` ...d: [predicate: ((value: Emoji, index: number, obj: Emoji[]) => unknown), thisArg?: any]

`Optional` updated: Emoji[]

`Optional` thisArg: any

`Rest` ...d: [compareFn?: ((a: Emoji, b: Emoji) => number)]