Class Attachment

Hierarchy

Attachment

Index

Constructors

constructor

Properties

file
name

Methods

Constructors

constructor

new Attachment(attachment?: Partial<Attachment>): Attachment

- Defined in src/lib/caching/structures/Attachment.ts:20
Parameters
- Default value attachment: Partial<Attachment> = {}
Returns Attachment

Properties

Optional file

file: string | Readable | Buffer | MessageAttachment

The unresolved file to send to the api

Optional name

name: undefined | string

The name of the Attachment

Methods

resolve

resolve(): Promise<File>

- Defined in src/lib/caching/structures/Attachment.ts:48
Resolves a stream, url, file location, or text into a buffer we can send to the api

Returns Promise<File>

setFile

setFile(file: string | Readable | Buffer | MessageAttachment): this

- Defined in src/lib/caching/structures/Attachment.ts:40
Allows you to set the file of the attachment

Parameters
- file: string | Readable | Buffer | MessageAttachment
  
  The unresolved file to send to the api
Returns this

setName

setName(name: string): this

- Defined in src/lib/caching/structures/Attachment.ts:31
Allows you to set the name of the attachment

Parameters
- name: string
  
  The name of the Attachment
Returns this

Generated using TypeDoc