LogoAntiRaid

@discord-types/builders/embed/image

API reference for @discord-types/builders/embed/image

@discord-types/builders/embed/image

Types

Image

Raw Type
type Image = Image.Prototype, & {
	url: string,

	proxyUrl: string?,

	height: number?,

	width: number?
}

Intersection with variants:

Variant 2
PropTypeDescription
url
-
proxyUrl?
-
height?
-
width?
-

JSON

Raw Type
type JSON = Image.Prototype.build({} :: any),

Functions

Image.Prototype.setUrl

[[ Set the image url for this embed. ]]

Function Signature
--[[
	Set the image url for this embed.
]]
function Image.Prototype.setUrl(self: Image, url: string, proxyUrl: string?) -> Image end

Arguments

url

string

proxyUrl

This field is optional and may not be specified

string?

Returns

ret1

Image

Image.Prototype.setHeight

[[ Set the image height for this embed. ]]

Function Signature
--[[
	Set the image height for this embed.
]]
function Image.Prototype.setHeight(self: Image, height: number) -> Image end

Arguments

height

number

Returns

ret1

Image

Image.Prototype.setWidth

[[ Set the image width for this embed. ]]

Function Signature
--[[
	Set the image width for this embed.
]]
function Image.Prototype.setWidth(self: Image, width: number) -> Image end

Arguments

width

number

Returns

ret1

Image

Image.Prototype.build

[[ Responsible for building the function Image.Prototype.build(self: Image): JSON JSON that can be parsed by the Discord API. ]]

Function Signature
--[[
	Responsible for building the function Image.Prototype.build(self: Image): JSON
 JSON that can be parsed by the Discord API.
]]
function Image.Prototype.build(self: Image) -> JSON end

Returns

ret1

JSON

Image.Interface.new

[[ Responsible for creating a new Image.

```lua

``` ]]

Function Signature
--[[
	Responsible for creating a new Image.

	\`\`\`lua
	
	\`\`\`
]]
function Image.Interface.new(resource: {
		url: string,

		proxyUrl: string?,

		height: number?,

		width: number?
	}?) -> Image end

Arguments

resource

This field is optional and may not be specified

{url: string, proxyUrl: string?, height: number?, width: number?}?

Returns

ret1

Image

Last updated on