Working with Attachments¶

Attachment operations are available via doc.attachments.

upload¶

Uploads one or more files and returns their attachment IDs. These IDs can be stored in Attachments-typed columns.

const [id] = await doc.attachments.upload([
  { filename: "report.pdf", data: pdfBuffer, type: "application/pdf" },
]);

Accepts File, Blob, or an object with filename, data (a Blob, Uint8Array, or ArrayBuffer), and an optional type.

Retrieves metadata for an attachment by ID.

const meta = await doc.attachments.get(id);
console.log(meta.fileName, meta.fileSize, meta.timeUploaded);

Downloads an attachment as a Blob.

const blob = await doc.attachments.download(id);

Downloads an attachment as a readable byte stream.

const stream = await doc.attachments.downloadStream(id);