Class File

Represents a file component builder. Used to display files within containers.

Example

const file = new File()
 .setMedia('https://example.com/image.png')
 .setSpoiler();

Hierarchy (View Summary)

BaseComponentBuilder<APIFileComponent>
- File

Index

Constructors

Properties

Methods

setId setMedia setSpoiler toJSON

Constructors

constructor

new File(data?: Partial<APIFileComponent>): File
Constructs a new File component.
Parameters
- data: Partial<APIFileComponent> = {}
  Optional initial data for the file component.
Returns File
Overrides BaseComponentBuilder.constructor
- Defined in src/builders/File.ts:19

Properties

data

data: Partial<TYPE> = {}

Methods

setId

setId(id: number): File
Sets the ID for the file component.
Parameters
- id: number
  The ID to set.
Returns File
The updated File instance.
- Defined in src/builders/File.ts:28

setMedia

setMedia(url: string): File
Sets the media URL for the file.
Parameters
- url: string
  The URL of the file to display.
Returns File
The updated File instance.
- Defined in src/builders/File.ts:38

setSpoiler

setSpoiler(spoiler?: boolean): File
Sets whether the file should be visually marked as a spoiler.
Parameters
- spoiler: boolean = true
  Whether the file is a spoiler (defaults to true).
Returns File
The updated File instance.
- Defined in src/builders/File.ts:48

toJSON

toJSON(): APIFileComponent
Returns APIFileComponent
Inherited from BaseComponentBuilder.toJSON
- Defined in src/builders/Base.ts:8