EmbedsBuilder

Documentation / @discordeno/bot / EmbedsBuilder

Class: EmbedsBuilder

A builder to help create Discord embeds.

Example

const embeds = new EmbedBuilder()
 .setTitle('My Embed')
 .setDescription('This is my new embed')
 .newEmbed()
 .setTitle('My Second Embed')

Extends

Array<DiscordEmbed>

Constructors

new EmbedsBuilder()

new EmbedsBuilder(arrayLength): EmbedsBuilder

Parameters

• arrayLength: number

Returns

EmbedsBuilder

Inherited from

Array<DiscordEmbed>.constructor

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1508

new EmbedsBuilder()

new EmbedsBuilder(...items): EmbedsBuilder

Parameters

• ...items: DiscordEmbed[]

Returns

EmbedsBuilder

Inherited from

Array<DiscordEmbed>.constructor

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1509

Properties

[unscopables]

readonly [unscopables]: object

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

[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.

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.

[iterator]?

optional [iterator]

at?

optional at

concat?

optional concat

copyWithin?

optional copyWithin

entries?

optional entries

every?

optional every

fill?

optional fill

filter?

optional filter

find?

optional find

findIndex?

optional findIndex

flat?

optional flat

flatMap?

optional flatMap

forEach?

optional forEach

includes?

optional includes

indexOf?

optional indexOf

join?

optional join

keys?

optional keys

lastIndexOf?

optional lastIndexOf

map?

optional map

pop?

optional pop

push?

optional push

reduce?

optional reduce

reduceRight?

optional reduceRight

reverse?

optional reverse

shift?

optional shift

slice?

optional slice

some?

optional some

sort?

optional sort

splice?

optional splice

toLocaleString?

optional toLocaleString

toString?

optional toString

unshift?

optional unshift

values?

optional values

Inherited from

Array.[unscopables]

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97

length

length: number

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

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1326

[species]

readonly static [species]: ArrayConstructor

Inherited from

Array.[species]

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316

Methods

[iterator]()

[iterator](): ArrayIterator<DiscordEmbed>

Iterator

Returns

ArrayIterator<DiscordEmbed>

Inherited from

Array.[iterator]

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:78

addField()

addField(name, value, inline?): this

Adds a new field to the embed fields array.

Parameters

• name: string

Field name

• value: string

Field value

• inline?: boolean

Field should be inline or not.

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:22

at()

at(index): undefined | DiscordEmbed

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

undefined | DiscordEmbed

Inherited from

Array.at

Defined in

node_modules/typescript/lib/lib.es2022.array.d.ts:24

concat()

concat(items)

concat(...items): DiscordEmbed[]

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

DiscordEmbed[]

Inherited from

Array.concat

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1350

concat(items)

concat(...items): DiscordEmbed[]

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

DiscordEmbed[]

Inherited from

Array.concat

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1356

copyWithin()

copyWithin(target, start, end?): this

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

Defined in

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

entries()

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

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

Returns

ArrayIterator<[number, DiscordEmbed]>

Inherited from

Array.entries

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:83

every()

every(predicate, thisArg)

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

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

Type Parameters

• S extends DiscordEmbed

Parameters

• predicate

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

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1433

every(predicate, thisArg)

every(predicate, thisArg?): boolean

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

Parameters

• predicate

• 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

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1442

fill()

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

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

Parameters

• value: DiscordEmbed

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

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:51

filter()

filter(predicate, thisArg)

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

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

Type Parameters

• S extends DiscordEmbed

Parameters

• predicate

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

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1469

filter(predicate, thisArg)

filter(predicate, thisArg?): DiscordEmbed[]

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

Parameters

• predicate

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

DiscordEmbed[]

Inherited from

Array.filter

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1475

find()

find(predicate, thisArg)

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

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

Type Parameters

• S extends DiscordEmbed

Parameters

• predicate

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

undefined | S

Inherited from

Array.find

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:29

find(predicate, thisArg)

find(predicate, thisArg?): undefined | DiscordEmbed

Parameters

• predicate

• thisArg?: any

Returns

undefined | DiscordEmbed

Inherited from

Array.find

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:30

findIndex()

findIndex(predicate, thisArg?): number

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

Parameters

• predicate

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

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:41

flat()

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

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

Type Parameters

• A

• D extends number = 1

Parameters

• this: A

• depth?: D

The maximum recursion depth

Returns

FlatArray<A, D>[]

Inherited from

Array.flat

Defined in

node_modules/typescript/lib/lib.es2019.array.d.ts:75

flatMap()

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

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

• This = undefined

Parameters

• callback

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

Defined in

node_modules/typescript/lib/lib.es2019.array.d.ts:64

forEach()

forEach(callbackfn, thisArg?): void

Performs the specified action for each element in an array.

Parameters

• callbackfn

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

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1457

includes()

includes(searchElement, fromIndex?): boolean

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

Parameters

• searchElement: DiscordEmbed

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

Defined in

node_modules/typescript/lib/lib.es2016.array.include.d.ts:25

indexOf()

indexOf(searchElement, fromIndex?): number

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

Parameters

• searchElement: DiscordEmbed

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

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1418

join()

join(separator?): string

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

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1361

keys()

keys(): ArrayIterator<number>

Returns an iterable of keys in the array

Returns

ArrayIterator<number>

Inherited from

Array.keys

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:88

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number

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

Parameters

• searchElement: DiscordEmbed

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

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1424

map()

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

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

Type Parameters

• U

Parameters

• callbackfn

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

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1463

newEmbed()

newEmbed(): this

Creates a blank embed.

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:28

pop()

pop(): undefined | DiscordEmbed

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

undefined | DiscordEmbed

Inherited from

Array.pop

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1339

push()

push(...items): number

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

Parameters

• ...items: DiscordEmbed[]

New elements to add to the array.

Returns

number

Inherited from

Array.push

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1344

reduce()

reduce(callbackfn)

reduce(callbackfn): DiscordEmbed

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

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

Returns

DiscordEmbed

Inherited from

Array.reduce

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1481

reduce(callbackfn, initialValue)

reduce(callbackfn, initialValue): DiscordEmbed

Parameters

• callbackfn

• initialValue: DiscordEmbed

Returns

DiscordEmbed

Inherited from

Array.reduce

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1482

reduce(callbackfn, initialValue)

reduce<U>(callbackfn, initialValue): U

Type Parameters

• U

Parameters

• callbackfn

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

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1488

reduceRight()

reduceRight(callbackfn)

reduceRight(callbackfn): DiscordEmbed

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

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

Returns

DiscordEmbed

Inherited from

Array.reduceRight

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1494

reduceRight(callbackfn, initialValue)

reduceRight(callbackfn, initialValue): DiscordEmbed

Parameters

• callbackfn

• initialValue: DiscordEmbed

Returns

DiscordEmbed

Inherited from

Array.reduceRight

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1495

reduceRight(callbackfn, initialValue)

reduceRight<U>(callbackfn, initialValue): U

Type Parameters

• U

Parameters

• callbackfn

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

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1501

reverse()

reverse(): DiscordEmbed[]

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

Returns

DiscordEmbed[]

Inherited from

Array.reverse

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1366

setAuthor()

setAuthor(name, options?): this

Set the current embed author.

Parameters

• name: string

Name of the author

• options?: Omit<DiscordEmbedAuthor, "name">

Extra author options

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:36

setColor()

setColor(color): this

Set the color on the side of the current embed.

Parameters

• color: string | number

The color, in base16 or hex color code

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:43

setCurrentEmbed()

setCurrentEmbed(index?): this

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

Defined in

packages/utils/dist/types/builders/embeds.d.ts:52

setDescription()

setDescription(description): this

Set the description of the current embed.

Parameters

• description: string

Description

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:59

setFields()

setFields(fields): this

Overwrite all fields on the current embed.

Parameters

• fields: DiscordEmbedField[]

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:66

setFooter()

setFooter(text, options?): this

Set the footer in the current embed.

Parameters

• text: string

The text to display in the footer

• options?: Omit<DiscordEmbedFooter, "text">

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:74

setImage()

setImage(url, options?): this

Set the image in the current embed.

Parameters

• url: string

URL of the image

• options?: Omit<DiscordEmbedImage, "url">

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:82

setProvider()

setProvider(name, url?): this

Set the provider of the current embed.

Parameters

• name: string

• url?: string

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:90

setRandomColor()

setRandomColor(): this

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

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:96

setThumbnail()

setThumbnail(url, options?): this

Set the thumbnail of the current embed.

Parameters

• url: string

URL of the image

• options?: Omit<DiscordEmbedThumbnail, "url">

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:119

setTimestamp()

setTimestamp(timestamp?): this

Set the timestamp of the current embed.

Parameters

• timestamp?: string | number | Date

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:111

setTitle()

setTitle(title, url?): this

Set the title of the current embed.

Parameters

• title: string

• url?: string

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:104

setUrl()

setUrl(url): this

Set the URL of the current embed title.

Parameters

• url: string

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:126

setVideo()

setVideo(url, options?): this

Set the video of the current embed.

Parameters

• url: string

• options?: Omit<DiscordEmbedVideo, "url">

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:134

shift()

shift(): undefined | DiscordEmbed

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

undefined | DiscordEmbed

Inherited from

Array.shift

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1371

slice()

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

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

DiscordEmbed[]

Inherited from

Array.slice

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1381

some()

some(predicate, thisArg?): boolean

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

Parameters

• predicate

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

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1451

sort()

sort(compareFn?): this

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

Parameters

• compareFn?

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, ASCII character order.

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

Returns

this

Inherited from

Array.sort

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1392

splice()

splice(start, deleteCount)

splice(start, deleteCount?): DiscordEmbed[]

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.

Returns

DiscordEmbed[]

An array containing the elements that were deleted.

Inherited from

Array.splice

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1399

splice(start, deleteCount, items)

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

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.

• ...items: DiscordEmbed[]

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

Returns

DiscordEmbed[]

An array containing the elements that were deleted.

Inherited from

Array.splice

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1407

toLocaleString()

toLocaleString(undefined)

toLocaleString(): string

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

Returns

string

Inherited from

Array.toLocaleString

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1334

toLocaleString(locales, options)

toLocaleString(locales, options?): string

Parameters

• locales: string | string[]

• options?: NumberFormatOptions & DateTimeFormatOptions

Returns

string

Inherited from

Array.toLocaleString

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:64

toString()

toString(): string

Returns a string representation of an array.

Returns

string

Inherited from

Array.toString

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1330

unshift()

unshift(...items): number

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

Parameters

• ...items: DiscordEmbed[]

Elements to insert at the start of the array.

Returns

number

Inherited from

Array.unshift

Defined in

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

validate()

validate(): this

Validate all embeds available against current known Discord limits to help prevent bad requests.

Returns

this

Defined in

packages/utils/dist/types/builders/embeds.d.ts:140

values()

values(): ArrayIterator<DiscordEmbed>

Returns an iterable of values in the array

Returns

ArrayIterator<DiscordEmbed>

Inherited from

Array.values

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:93

from()

from(arrayLike)

static from<T>(arrayLike): T[]

Creates an array from an array-like object.

Type Parameters

• T

Parameters

• arrayLike: ArrayLike<T>

An array-like object to convert to an array.

Returns

T[]

Inherited from

Array.from

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:72

from(arrayLike, mapfn, thisArg)

static from<T, U>(arrayLike, mapfn, thisArg?): U[]

Creates an array from an iterable object.

Type Parameters

• T

• U

Parameters

• arrayLike: ArrayLike<T>

An array-like object to convert to an array.

• mapfn

A mapping function to call on every element of the array.

• thisArg?: any

Value of 'this' used to invoke the mapfn.

Returns

U[]

Inherited from

Array.from

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:80

from(iterable)

static from<T>(iterable): T[]

Creates an array from an iterable object.

Type Parameters

• T

Parameters

• iterable: Iterable<T, any, any> | ArrayLike<T>

An iterable object to convert to an array.

Returns

T[]

Inherited from

Array.from

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:101

from(iterable, mapfn, thisArg)

static from<T, U>(iterable, mapfn, thisArg?): U[]

Creates an array from an iterable object.

Type Parameters

• T

• U

Parameters

• iterable: Iterable<T, any, any> | ArrayLike<T>

An iterable object to convert to an array.

• mapfn

A mapping function to call on every element of the array.

• thisArg?: any

Value of 'this' used to invoke the mapfn.

Returns

U[]

Inherited from

Array.from

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:109

isArray()

static isArray(arg): arg is any[]

Parameters

• arg: any

Returns

arg is any[]

Inherited from

Array.isArray

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1513

of()

static of<T>(...items): T[]

Returns a new array from a set of elements.

Type Parameters

• T

Parameters

• ...items: T[]

A set of elements to include in the new array object.

Returns

T[]

Inherited from

Array.of

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:86

Class: EmbedsBuilder

Example​

Extends​

Constructors​

new EmbedsBuilder()​

Parameters​

Returns​

Inherited from​

Defined in​

new EmbedsBuilder()​

Parameters​

Returns​

Inherited from​

Defined in​

Properties​

[unscopables]​

[unscopables]?​

length?​

[iterator]?​

at?​

concat?​

copyWithin?​

entries?​

every?​

fill?​

filter?​

find?​

findIndex?​

flat?​

flatMap?​

forEach?​

includes?​

indexOf?​

join?​

keys?​

lastIndexOf?​

map?​

pop?​

push?​

reduce?​

reduceRight?​

reverse?​

shift?​

slice?​

some?​

sort?​

splice?​

toLocaleString?​

toString?​

unshift?​

values?​

Inherited from​

Defined in​

length​

Inherited from​

Defined in​

[species]​

Inherited from​

Defined in​

Methods​

[iterator]()​

Returns​

Inherited from​

Defined in​

addField()​

Parameters​

Returns​

Defined in​

at()​

Parameters​

Returns​

Inherited from​

Defined in​

concat()​

concat(items)​

Parameters​

Returns​

Inherited from​

Defined in​

concat(items)​

Example

Extends

Constructors

new EmbedsBuilder()

Parameters

Returns

Inherited from

Defined in

new EmbedsBuilder()

Parameters

Returns

Inherited from

Defined in

Properties

[unscopables]

[unscopables]?

length?

[iterator]?

at?

concat?

copyWithin?

entries?

every?

fill?

filter?

find?

findIndex?

flat?

flatMap?

forEach?

includes?

indexOf?

join?

keys?

lastIndexOf?

map?

pop?

push?

reduce?

reduceRight?

reverse?

shift?

slice?

some?

sort?

splice?

toLocaleString?

toString?

unshift?

values?

Inherited from

Defined in

length

Inherited from

Defined in

[species]

Inherited from

Defined in

Methods

[iterator]()

Returns

Inherited from

Defined in

addField()

Parameters

Returns

Defined in

at()

Parameters

Returns

Inherited from

Defined in

concat()

concat(items)

Parameters

Returns

Inherited from

Defined in

concat(items)

Parameters