Yor.ts | classes/Emoji

yor.ts / Exports / Emoji

Class: Emoji

Hierarchy

• Base

  ↳ Emoji

Table of contents

Constructors

• constructor

Properties

• animated
• available
• client
• creator
• id
• managed
• name
• raw
• requireColons
• roles

Methods

• createdAt
• createdTimestamp
• identifier
• imageURL
• toString

Constructors

constructor

• new Emoji(client, data): Emoji

Represents an emoji on the Discord platform.

Parameters

Name	Type	Description
client	YorClient	The client object.
data	APIEmoji	The APIEmoji data.

Returns

Emoji

Overrides

Base.constructor

Defined in

src/structures/Emoji.ts:31

Properties

animated

• Optional animated: boolean

Defined in

src/structures/Emoji.ts:20

---

available

• Optional available: boolean

Defined in

src/structures/Emoji.ts:21

---

client

• client: YorClient

Inherited from

Base.client

Defined in

src/structures/Base.ts:4

---

creator

• Optional creator: User

Defined in

src/structures/Emoji.ts:17

---

id

• id: string

Defined in

src/structures/Emoji.ts:14

---

managed

• Optional managed: boolean

Defined in

src/structures/Emoji.ts:19

---

name

• name: string

Defined in

src/structures/Emoji.ts:15

---

raw

• raw: APIEmoji

Defined in

src/structures/Emoji.ts:13

---

requireColons

• Optional requireColons: boolean

Defined in

src/structures/Emoji.ts:18

---

roles

• Optional roles: string[]

Defined in

src/structures/Emoji.ts:16

Methods

createdAt

▸ createdAt(): Date

Returns the creation date of the object.

Returns

Date

The creation date of the object.

Defined in

src/structures/Emoji.ts:95

---

createdTimestamp

▸ createdTimestamp(): number

Returns the created timestamp as a Date object.

Returns

number

The created timestamp.

Defined in

src/structures/Emoji.ts:81

---

identifier

▸ identifier(): string

The identifier of this emoji, used for message reactions

Returns

string

The identifier string for the object.

Defined in

src/structures/Emoji.ts:52

---

imageURL

▸ imageURL(options?): string

Generates the URL of the image with the given options.

Parameters

Name	Type	Description
options?	BaseImageURLOptions	Optional options for generating the image URL.

Returns

string

The generated image URL.

Defined in

src/structures/Emoji.ts:63

---

toString

▸ toString(): string

Returns a string representation of the emoji

Returns

string

The string representation of the emoji

Defined in

src/structures/Emoji.ts:72