EmbedBuilder

EmbedBuilder

Makes creating embeds simplier

Constructor

new EmbedBuilder()

Source:
Properties:
Name Type Description
author Object

The author of the embed

color Number

The color of the embed

description String

The description of the embed

fields Array

An array of embed fields

footer Object

The footer of the embed

image String

The image of the embed

timestamp String

The timestamp of the embed

title String

The title of the embed

thumbnail String

The thumbnail of the embed

type String

The type of the embed

Methods

makeAuthor(optionsopt) → {EmbedBuilder}

Source:

Makes an embed author

Parameters:
Name Type Attributes Description
options Object <optional>

Options for the Author to make for the embed

Properties
Name Type Attributes Description
name String <optional>

The name of the author

iconURL String <optional>

The url of the icon of the author

url Stirng <optional>

The url of the author

Returns:
Type
EmbedBuilder

makeColor(coloropt) → {EmbedBuilder}

Source:

Makes the color of the embed

Parameters:
Name Type Attributes Description
color String | Number <optional>

The color of the embed

Returns:
Type
EmbedBuilder

makeDescription(descriptionopt) → {EmbedBuilder}

Source:

Makes an embed description

Parameters:
Name Type Attributes Description
description String <optional>

The description of the embed

Returns:
Type
EmbedBuilder

makeFooter(text, iconURL) → {EmbedBuilder}

Source:

Makes an embed footer

Parameters:
Name Type Description
text String

The footer text

iconURL String

The icon of the footer

Returns:
Type
EmbedBuilder

makeImage(url) → {EmbedBuilder}

Source:

Make the image of the embed

Parameters:
Name Type Description
url String

The url of the image

Returns:
Type
EmbedBuilder

makeThumbnail(url) → {EmbedBuilder}

Source:

Make the thumbnail of the embed

Parameters:
Name Type Description
url String

The url of the thumbnail

Returns:
Type
EmbedBuilder

makeTimestamp(timestamp) → {EmbedBuilder}

Source:

Make the timestamp of the embed

Parameters:
Name Type Description
timestamp String

The timestamp of the embed

Returns:
Type
EmbedBuilder

pushField(optionsopt)

Source:

Pushes a field to the embed

Parameters:
Name Type Attributes Description
options Object <optional>

Options for the field

Properties
Name Type Attributes Default Description
name String

The name of the field

value String

The value of the field

inline Boolean <optional>
false

Whether to inline the embed