AttachmentBuilder

AttachmentBuilder wraps raw binary data into a named attachment object for use in message sends.

Import

TypeScript

import { AttachmentBuilder } from "lunibee";

JavaScript

import { AttachmentBuilder } from "lunibee";

Constructor

TypeScript

new AttachmentBuilder(data: Uint8Array | ArrayBuffer | Buffer, options?: AttachmentData)

JavaScript

new AttachmentBuilder(data: Uint8Array | ArrayBuffer | Buffer, options?: AttachmentData)

Parameter	Type	Description
data	Uint8Array | ArrayBuffer | Buffer	Raw file data.
options.name	string	Filename including extension (e.g. "image.png").
options.description	string	Alt text description for the file.

Methods

setName(name)

Sets or changes the filename.

TypeScript

attachment.setName("welcome-banner.png");

JavaScript

attachment.setName("welcome-banner.png");

setDescription(description)

Sets the alt text for the file.

TypeScript

attachment.setDescription("A welcome banner for new members.");

JavaScript

attachment.setDescription("A welcome banner for new members.");

toJSON()

Serializes to a REST-ready attachment object.

Examples

Send a generated image

TypeScript

import { AttachmentBuilder } from "lunibee";
import { readFile } from "node:fs/promises";

const imageData = await readFile("./assets/welcome.png");
const attachment = new AttachmentBuilder(imageData, {
  name: "welcome.png",
  description: "Welcome banner",
});

await channel.send({ files: [attachment] });

JavaScript

import { AttachmentBuilder } from "lunibee";
import { readFile } from "node:fs/promises";

const imageData = await readFile("./assets/welcome.png");
const attachment = new AttachmentBuilder(imageData, {
  name: "welcome.png",
  description: "Welcome banner",
});

await channel.send({ files: [attachment] });

Send with an embed referencing the attachment

TypeScript

const attachment = new AttachmentBuilder(imageData, { name: "chart.png" });
const embed = new EmbedBuilder()
  .setTitle("Monthly Stats")
  .setImage("attachment://chart.png"); // reference the attachment by name

await channel.send({ embeds: [embed], files: [attachment] });

JavaScript

const attachment = new AttachmentBuilder(imageData, { name: "chart.png" });
const embed = new EmbedBuilder()
  .setTitle("Monthly Stats")
  .setImage("attachment://chart.png"); // reference the attachment by name

await channel.send({ embeds: [embed], files: [attachment] });