Interface File

interface File {
    contents: Buffer;
    field?: string;
    index?: number;
    name: string;
}

Properties

contents: Buffer

the contents of the file

field?: string

The form field used for the file, defaults to files[${index}]. DO NOT SET UNLESS YOU KNOW WHAT YOU'RE DOING

index?: number

The index to use when uploading the file. You can use this to reference this specific file from attachments.

name: string

the name of the file