AttachmentBuilder

Constructors

new AttachmentBuilder(data)

1
new AttachmentBuilder(data: Partial<AttachmentData>): AttachmentBuilder

Creates a new Attachment instance.

Parameters

Parameter	Type	Description
`data`	`Partial`<`AttachmentData`>	The partial attachment data.

Returns

AttachmentBuilder

Source

seyfert/src/builders/Attachment.ts:42

Properties

Property	Modifier	Type	Description
`data`	`public`	`Partial`<`AttachmentData`>	The partial attachment data.

Accessors

spoiler

1
get spoiler(): boolean

Gets whether the attachment is a spoiler.

Returns

boolean

Source

seyfert/src/builders/Attachment.ts:104

Methods

setDescription()

1
setDescription(desc: string): this

Sets the description of the attachment.

Parameters

Parameter	Type	Description
`desc`	`string`	The description of the attachment.

Returns

this

The Attachment instance.

Example

1
attachment.setDescription('This is an example attachment');

Source

seyfert/src/builders/Attachment.ts:63

setFile()

1
setFile<T>(type: T, data: AttachmentResolvableMap[T]): this

Sets the file data of the attachment.

Type parameters

Type parameter	Value
`T` extends keyof `AttachmentResolvableMap`	keyof `AttachmentResolvableMap`

Parameters

Parameter	Type	Description
`type`	`T`	The type of the attachment data.
`data`	`AttachmentResolvableMap`[`T`]	The resolvable data of the attachment.

Returns

this

The Attachment instance.

Example

1
attachment.setFile('url', 'https://example.com/example.jpg');
2
attachment.setFile('path', '../assets/example.jpg');
3
attachment.setFile('buffer', Buffer.from(image.decode()));

Source

seyfert/src/builders/Attachment.ts:78

setName()

1
setName(name: string): this

Sets the name of the attachment.

Parameters

Parameter	Type	Description
`name`	`string`	The name of the attachment.

Returns

this

The Attachment instance.

Example

1
attachment.setName('example.jpg');

Source

seyfert/src/builders/Attachment.ts:51

setSpoiler()

1
setSpoiler(spoiler: boolean): this

Sets whether the attachment is a spoiler.

Parameters

Parameter	Type	Description
`spoiler`	`boolean`	Whether the attachment is a spoiler.

Returns

this

The Attachment instance.

Example

1
attachment.setSpoiler(true);

Source

seyfert/src/builders/Attachment.ts:91

toJSON()

1
toJSON(): AttachmentData

Converts the Attachment instance to JSON.

Returns

AttachmentData

The JSON representation of the Attachment instance.

Source

seyfert/src/builders/Attachment.ts:112