EmbedsBuilder

Returns

EmbedsBuilder

Inherited from

Array<DiscordEmbed>.constructor

Properties

[unscopables]

readonly [unscopables]: object

Defined in: node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:95

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Index Signature

[key: number]: boolean | undefined

[iterator]?

optional [iterator]?: boolean

[unscopables]?

readonly optional [unscopables]?: boolean

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

at?

optional at?: boolean

concat?

optional concat?: boolean

copyWithin?

optional copyWithin?: boolean

entries?

optional entries?: boolean

every?

optional every?: boolean

fill?

optional fill?: boolean

filter?

optional filter?: boolean

find?

optional find?: boolean

findIndex?

optional findIndex?: boolean

flat?

optional flat?: boolean

flatMap?

optional flatMap?: boolean

forEach?

optional forEach?: boolean

includes?

optional includes?: boolean

indexOf?

optional indexOf?: boolean

join?

optional join?: boolean

keys?

optional keys?: boolean

lastIndexOf?

optional lastIndexOf?: boolean

length?

optional length?: boolean

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

map?

optional map?: boolean

pop?

optional pop?: boolean

push?

optional push?: boolean

reduce?

optional reduce?: boolean

reduceRight?

optional reduceRight?: boolean

reverse?

optional reverse?: boolean

shift?

optional shift?: boolean

slice?

optional slice?: boolean

some?

optional some?: boolean

sort?

optional sort?: boolean

splice?

optional splice?: boolean

toLocaleString?

optional toLocaleString?: boolean

toString?

optional toString?: boolean

unshift?

optional unshift?: boolean

values?

optional values?: boolean

Inherited from

Array.[unscopables]

length

length: number

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1327

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Inherited from

Array.length

[species]

readonly static [species]: ArrayConstructor

Defined in: node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:314

Inherited from

Array.[species]

Methods

[iterator]()

[iterator](): ArrayIterator<DiscordEmbed>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:76

Iterator

Returns

ArrayIterator<DiscordEmbed>

Inherited from

Array.[iterator]

addField()

addField(name, value, inline?): this

Defined in: packages/utils/src/builders/embeds.ts:31

Adds a new field to the current embed.

Parameters

name

string

Field name

value

string

Field value

inline?

boolean

Field should be inline or not.

Returns

this

addFields()

addFields(fields): this

Defined in: packages/utils/src/builders/embeds.ts:51

Adds multiple new fields to the current embed.

Parameters

fields

DiscordEmbedField[]

The fields to add

Returns

this

at()

at(index): DiscordEmbed | undefined

Defined in: node_modules/typescript/lib/lib.es2022.array.d.ts:22

Returns the item located at the specified index.

Parameters

index

number

The zero-based index of the desired code unit. A negative index will count back from the last item.

Returns

DiscordEmbed | undefined

Inherited from

Array.at

concat()

Call Signature

concat(...items): DiscordEmbed[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1351

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

items

...ConcatArray<DiscordEmbed>[]

Additional arrays and/or items to add to the end of the array.

Returns

Inherited from

Array.concat

Call Signature

concat(...items): DiscordEmbed[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1357

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

items

...(DiscordEmbed | ConcatArray<DiscordEmbed>)[]

Additional arrays and/or items to add to the end of the array.

Returns

Inherited from

Array.concat

copyWithin()

copyWithin(target, start, end?): this

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:60

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters

target

number

If target is negative, it is treated as length+target where length is the length of the array.

start

number

If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

end?

number

If not specified, length of the this object is used as its default value.

Returns

this

Inherited from

Array.copyWithin

entries()

entries(): ArrayIterator<[number, DiscordEmbed]>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:81

Returns an iterable of key, value pairs for every entry in the array

Returns

ArrayIterator<[number, DiscordEmbed]>

Inherited from

Array.entries

every()

Call Signature

every<S>(predicate, thisArg?): this is S[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1438

Determines whether all the members of an array satisfy the specified test.

Type Parameters

S

S extends DiscordEmbed

Parameters

predicate

(value, index, array) => value is S

A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

this is S[]

Inherited from

Array.every

Call Signature

every(predicate, thisArg?): boolean

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1447

Determines whether all the members of an array satisfy the specified test.

Parameters

predicate

(value, index, array) => unknown

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

Array.every

fill()

fill(value, start?, end?): this

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:49

Changes all array elements from start to end index to a static value and returns the modified array

Parameters

value

value to fill array section with

start?

number

index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

end?

number

index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

this

Inherited from

Array.fill

filter()

Call Signature

filter<S>(predicate, thisArg?): S[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1474

Returns the elements of an array that meet the condition specified in a callback function.

Type Parameters

S

S extends DiscordEmbed

Parameters

predicate

(value, index, array) => value is S

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

S[]

Inherited from

Array.filter

Call Signature

filter(predicate, thisArg?): DiscordEmbed[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1480

Returns the elements of an array that meet the condition specified in a callback function.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

Inherited from

Array.filter

find()

Call Signature

find<S>(predicate, thisArg?): S | undefined

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:27

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type Parameters

S

S extends DiscordEmbed

Parameters

predicate

(value, index, obj) => value is S

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

S | undefined

Inherited from

Array.find

Call Signature

find(predicate, thisArg?): DiscordEmbed | undefined

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:28

Parameters

predicate

(value, index, obj) => unknown

thisArg?

any

Returns

DiscordEmbed | undefined

Inherited from

Array.find

findIndex()

findIndex(predicate, thisArg?): number

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:39

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters

predicate

(value, index, obj) => unknown

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

Inherited from

Array.findIndex

flat()

flat<A, D>(this, depth?): FlatArray<A, D>[]

Defined in: node_modules/typescript/lib/lib.es2019.array.d.ts:73

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type Parameters

A

A

D

D extends number = 1

Parameters

this

A

depth?

D

The maximum recursion depth

Returns

FlatArray<A, D>[]

Inherited from

Array.flat

flatMap()

flatMap<U, This>(callback, thisArg?): U[]

Defined in: node_modules/typescript/lib/lib.es2019.array.d.ts:62

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type Parameters

U

U

This

This = undefined

Parameters

callback

(this, value, index, array) => U | readonly U[]

A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.

thisArg?

This

An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

Array.flatMap

forEach()

forEach(callbackfn, thisArg?): void

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1462

Performs the specified action for each element in an array.

Parameters

callbackfn

(value, index, array) => void

A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

void

Inherited from

Array.forEach

includes()

includes(searchElement, fromIndex?): boolean

Defined in: node_modules/typescript/lib/lib.es2016.array.include.d.ts:23

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters

searchElement

The element to search for.

fromIndex?

number

The position in this array at which to begin searching for searchElement.

Returns

boolean

Inherited from

Array.includes

indexOf()

indexOf(searchElement, fromIndex?): number

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1423

Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

Parameters

searchElement

The value to locate in the array.

fromIndex?

number

The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns

number

Inherited from

Array.indexOf

join()

join(separator?): string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1362

Adds all the elements of an array into a string, separated by the specified separator string.

Parameters

separator?

string

A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

Returns

string

Inherited from

Array.join

keys()

keys(): ArrayIterator<number>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:86

Returns an iterable of keys in the array

Returns

ArrayIterator<number>

Inherited from

Array.keys

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1429

Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

Parameters

searchElement

The value to locate in the array.

fromIndex?

number

The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

Returns

number

Inherited from

Array.lastIndexOf

map()

map<U>(callbackfn, thisArg?): U[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1468

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type Parameters

U

U

Parameters

callbackfn

(value, index, array) => U

A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

Array.map

newEmbed()

newEmbed(): this

Defined in: packages/utils/src/builders/embeds.ts:66

Creates a blank embed.

Returns

this

pop()

pop(): DiscordEmbed | undefined

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1340

Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

DiscordEmbed | undefined

Inherited from

Array.pop

push()

push(...items): number

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1345

Appends new elements to the end of an array, and returns the new length of the array.

Parameters

items

New elements to add to the array.

Returns

number

Inherited from

Array.push

reduce()

Call Signature

reduce(callbackfn): DiscordEmbed

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1486

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => DiscordEmbed

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns

Inherited from

Array.reduce

Call Signature

reduce(callbackfn, initialValue): DiscordEmbed

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1487

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => DiscordEmbed

initialValue

Returns

Inherited from

Array.reduce

Call Signature

reduce<U>(callbackfn, initialValue): U

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1493

Type Parameters

U

U

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => U

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

Array.reduce

reduceRight()

Call Signature

reduceRight(callbackfn): DiscordEmbed

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1499

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => DiscordEmbed

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns

Inherited from

Array.reduceRight

Call Signature

reduceRight(callbackfn, initialValue): DiscordEmbed

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1500

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => DiscordEmbed

initialValue

Returns

Inherited from

Array.reduceRight

Call Signature

reduceRight<U>(callbackfn, initialValue): U

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1506

Type Parameters

U

U

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => U

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

Array.reduceRight

reverse()

reverse(): DiscordEmbed[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1367

Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

Returns

Inherited from

Array.reverse

setAuthor()

setAuthor(name, options?): this

Defined in: packages/utils/src/builders/embeds.ts:84

Set the current embed author.

Parameters

name

string

Name of the author

options?

Omit<DiscordEmbedAuthor, "name">

Extra author options

Returns

this

setColor()

setColor(color): this

Defined in: packages/utils/src/builders/embeds.ts:100

Set the color on the side of the current embed.

Parameters

color

string | number

The color, in base16 or hex color code

Returns

this

setCurrentEmbed()

setCurrentEmbed(index?): this

Defined in: packages/utils/src/builders/embeds.ts:123

Set the current embed to a different index.

WARNING: Only use this method if you know what you're doing. Make sure to set it back to the latest when you're done.

Parameters

index?

number

The index of the embed in the EmbedsBuilder array

Returns

this

setDescription()

setDescription(description): this

Defined in: packages/utils/src/builders/embeds.ts:145

Set the description of the current embed.

Parameters

description

string

Description

Returns

this

setFields()

setFields(fields): this

Defined in: packages/utils/src/builders/embeds.ts:157

Overwrite all fields on the current embed.

Parameters

fields

DiscordEmbedField[]

Returns

this

setFooter()

setFooter(text, options?): this

Defined in: packages/utils/src/builders/embeds.ts:170

Set the footer in the current embed.

Parameters

text

string

The text to display in the footer

options?

Omit<DiscordEmbedFooter, "text">

Returns

this

setImage()

setImage(url, options?): this

Defined in: packages/utils/src/builders/embeds.ts:187

Set the image in the current embed.

Parameters

url

string

URL of the image

options?

Omit<DiscordEmbedImage, "url">

Returns

this

setProvider()

setProvider(name, url?): this

Defined in: packages/utils/src/builders/embeds.ts:204

Set the provider of the current embed.

Parameters

name

string

url?

string

Returns

this

setRandomColor()

setRandomColor(): this

Defined in: packages/utils/src/builders/embeds.ts:218

Set the color of the current embed to a random value.

Returns

this

setThumbnail()

setThumbnail(url, options?): this

Defined in: packages/utils/src/builders/embeds.ts:258

Set the thumbnail of the current embed.

Parameters

url

string

URL of the image

options?

Omit<DiscordEmbedImage, "url">

Returns

this

setTimestamp()

setTimestamp(timestamp?): this

Defined in: packages/utils/src/builders/embeds.ts:245

Set the timestamp of the current embed.

Parameters

timestamp?

string | number | Date

Returns

this

setTitle()

setTitle(title, url?): this

Defined in: packages/utils/src/builders/embeds.ts:229

Set the title of the current embed.

Parameters

title

string

url?

string

Returns

this

setUrl()

setUrl(url): this

Defined in: packages/utils/src/builders/embeds.ts:274

Set the URL of the current embed title.

Parameters

url

string

Returns

this

setVideo()

setVideo(url, options?): this

Defined in: packages/utils/src/builders/embeds.ts:287

Set the video of the current embed.

Parameters

url

string

options?

Omit<DiscordEmbedVideo, "url">

Returns

this

shift()

shift(): DiscordEmbed | undefined

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1372

Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

DiscordEmbed | undefined

Inherited from

Array.shift

slice()

slice(start?, end?): DiscordEmbed[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1382

Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

Parameters

start?

number

The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

end?

number

The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

Returns

Inherited from

Array.slice

some()

some(predicate, thisArg?): boolean

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1456

Determines whether the specified callback function returns true for any element of an array.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

Array.some

sort()

sort(compareFn?): this

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1393

Sorts an array in place. This method mutates the array and returns a reference to the same array.

Parameters

compareFn?

(a, b) => number

Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order.

[11,2,22,1].sort((a, b) => a - b)

Returns

this

Inherited from

Array.sort

splice()

Call Signature

splice(start, deleteCount?): DiscordEmbed[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1402

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount?

number

The number of elements to remove. Omitting this argument will remove all elements from the start paramater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.

Returns

An array containing the elements that were deleted.

Inherited from

Array.splice

Call Signature

splice(start, deleteCount, ...items): DiscordEmbed[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1412

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount

number

The number of elements to remove. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.

items

Elements to insert into the array in place of the deleted elements.

Returns

An array containing the elements that were deleted.

Inherited from

Array.splice

toLocaleString()

Call Signature

toLocaleString(): string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1335

Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

Returns

string

Inherited from

Array.toLocaleString

Call Signature

toLocaleString(locales, options?): string

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:62

Parameters

locales

string | string[]

options?

NumberFormatOptions & DateTimeFormatOptions

Returns

string

Inherited from

Array.toLocaleString

toString()

toString(): string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1331

Returns a string representation of an array.

Returns

string

Inherited from

Array.toString

unshift()

unshift(...items): number

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1417

Inserts new elements at the start of an array, and returns the new length of the array.

Parameters

items