Class Embed

Utils Embed Structure

Hierarchy

Structure
- Embed

Index

Constructors

constructor

Properties

Accessors

length
size

Constructors

constructor

new Embed(data?: RawMessageEmbed): Embed

Overrides Structure.constructor
- Defined in src/utils/embed.ts:45
Parameters
- data: RawMessageEmbed = {}
Returns Embed

Properties

Readonly _keys

_keys: BaseSet<string> = ...

Optional author

author: EmbedAuthor

Optional color

color: number

Optional description

description: string

Optional fields

fields: BaseCollection<number, EmbedField>

Optional footer

footer: EmbedFooter

Optional image

image: EmbedImage

Optional provider

provider: EmbedProvider

Optional referenceId

referenceId: string

Optional thumbnail

thumbnail: EmbedThumbnail

Optional timestamp

timestamp: Date

Optional title

title: string

type

type: string = ...

Optional url

url: string

Optional video

video: EmbedVideo

Accessors

length

get length(): number

- Defined in src/utils/embed.ts:52
Returns number

size

get size(): number

- Defined in src/utils/embed.ts:56
Returns number

Methods

[custom]

[custom](): object

Inherited from Structure.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_getFromSnake

_getFromSnake(key: string): any

Inherited from Structure._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_setFromSnake

_setFromSnake(key: string, value: any): any

Inherited from Structure._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

addField

addField(name: string, value: string, inline?: boolean): Embed

- Defined in src/utils/embed.ts:76
Parameters
- name: string
- value: string
- Optional inline: boolean
Returns Embed

difference

difference(key: string, value: any): [boolean, any]

Inherited from Structure.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from Structure.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from Structure.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

hasDifference

hasDifference(key: string, value: any): boolean

Inherited from Structure.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from Structure.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from Structure.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

merge

merge(data?: BaseStructureData): void

Inherited from Structure.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

mergeValue(key: string, value: any): void

Overrides Structure.mergeValue
- Defined in src/utils/embed.ts:158
Parameters
- key: string
- value: any
Returns void

setAuthor

setAuthor(name?: null | string, iconUrl?: null | string, url?: null | string): Embed

- Defined in src/utils/embed.ts:85
Parameters
- Optional name: null | string
- Optional iconUrl: null | string
- Optional url: null | string
Returns Embed

setColor

setColor(color: number): Embed

- Defined in src/utils/embed.ts:100
Parameters
- color: number
Returns Embed

setDescription

setDescription(description: null | string): Embed

- Defined in src/utils/embed.ts:105
Parameters
- description: null | string
Returns Embed

setFooter

setFooter(text: string, iconUrl?: null | string): Embed

- Defined in src/utils/embed.ts:110
Parameters
- text: string
- Optional iconUrl: null | string
Returns Embed

setImage

setImage(url: string): Embed

- Defined in src/utils/embed.ts:123
Parameters
- url: string
Returns Embed

setThumbnail

setThumbnail(url: string): Embed

- Defined in src/utils/embed.ts:130
Parameters
- url: string
Returns Embed

setTimestamp

setTimestamp(timestamp?: string | number | Date): Embed

- Defined in src/utils/embed.ts:137
Parameters
- timestamp: string | number | Date = ...
Returns Embed

setTitle

setTitle(title: string): Embed

- Defined in src/utils/embed.ts:148
Parameters
- title: string
Returns Embed

setUrl

setUrl(url: string): Embed

- Defined in src/utils/embed.ts:153
Parameters
- url: string
Returns Embed

toJSON

toJSON(): RawMessageEmbed

Overrides Structure.toJSON
- Defined in src/utils/embed.ts:236
Returns RawMessageEmbed

Generated using TypeDoc