Class Attachment

Represents an attachment.

See

https://discord.com/developers/docs/resources/channel#attachment-object-attachment-structure

Implements

Attachment

Index

Constructors

Accessors

channelId id name size url

Methods

[custom] fetchData toJSON toString

Constructors

constructor

new Attachment(
    client: Client,
    data:
        | APIAttachment
        | AttachmentStorageJSON
        | AttachmentCacheJSON
        | AttachmentDiscordJSON,
    __namedParameters: { channelId: string },
): Attachment
Creates a structure for an attachment.
Parameters
- client: Client
- data:
      | APIAttachment
      | AttachmentStorageJSON
      | AttachmentCacheJSON
      | AttachmentDiscordJSON
- __namedParameters: { channelId: string }
Returns Attachment
- Defined in src/structures/Attachment.ts:29

Accessors

channelId

get channelId(): string
The channel that this attachment belongs to.

Returns string
Implementation of AttachmentType.channelId
- Defined in src/structures/Attachment.ts:151

id

get id(): string
The id of the attachment.

Returns string
Implementation of AttachmentType.id
- Defined in src/structures/Attachment.ts:103

name

get name(): string
The name of the file.

Returns string
Implementation of AttachmentType.name
- Defined in src/structures/Attachment.ts:112

size

get size(): number
The size of the file.

Returns number
Implementation of AttachmentType.size
- Defined in src/structures/Attachment.ts:121

url

get url(): null | string
The url to the file.

Returns null | string
Implementation of AttachmentType.url
- Defined in src/structures/Attachment.ts:130

Methods

[custom]

"[custom]"(): string
Returns string
Method
- Defined in src/structures/Attachment.ts:177

fetchData

fetchData(): Promise<ArrayBuffer>
Fetches the data of the attachment.

Returns Promise<ArrayBuffer>
Implementation of AttachmentType.fetchData
- Defined in src/structures/Attachment.ts:159

toJSON

toJSON(
format?: JsonTypes,
): AttachmentStorageJSON | AttachmentCacheJSON | AttachmentDiscordJSON
Returns the JSON representation of this structure.
Parameters
- Optionalformat: JsonTypes
Returns AttachmentStorageJSON | AttachmentCacheJSON | AttachmentDiscordJSON
Implementation of AttachmentType.toJSON
- Defined in src/structures/Attachment.ts:184

toString

toString(): string
Returns string
Method
Implementation of AttachmentType.toString
- Defined in src/structures/Attachment.ts:169