class FileBuilder

export declare class FileBuilder extends ComponentBuilder<APIFileComponent>

A builder that creates API-compatible JSON data for files.

clearId
setId
setSpoiler
setURL
toJSON

Constructors

constructor(
data?: Partial<APIFileComponent>
)

Creates a new file.

Examples:Creating a file from an API data object:
const file = new FileBuilder({
	spoiler: true,
	file: {
		url: 'attachment://file.png',
	},
});
Creating a file using setters and API data:
const file = new FileBuilder({
	file: {
		url: 'attachment://image.jpg',
	},
})
	.setSpoiler(false);

clearId() : this

Clears the id of this component, defaulting to a default incremented id.

Inherited from: ComponentBuilder

setId(
id: number
) : this

Sets the id of this component.

Inherited from: ComponentBuilder

setSpoiler(
spoiler?: boolean
) : this

Sets the spoiler status of this file.

setURL(
url: string
) : this

Sets the media URL of this file.

toJSON(
validationOverride?: boolean
) : APIFileComponent

Serializes this builder to API-compatible JSON data.Note that by disabling validation, there is no guarantee that the resulting object will be valid.