Metadata - Chromiumly

Read metadata

import { PDFEngines } from "chromiumly";

const metadataBuffer = await PDFEngines.readMetadata({
  files: ["path/to/file_1.pdf", "path/to/file_2.pdf"],
  downloadFrom: [{ url: "https://cdn.example.com/file.pdf" }], // optional: read metadata from a remote PDF
});

Returns a buffer containing the metadata (format depends on Gotenberg). Typically used for inspection or debugging. downloadFrom, webhook, outputFilename, and trace are also accepted — see Request tracing.

Write metadata

import { PDFEngines } from "chromiumly";

const buffer = await PDFEngines.writeMetadata({
  files: ["path/to/file_1.pdf", "path/to/file_2.pdf"],
  metadata: {
    Author: "Your Name",
    Title: "Document Title",
    Keywords: ["pdf", "chromiumly"],
  },
});

The metadata object uses standard PDF/XMP field names. For a full list of supported keys, see ExifTool PDF/XMP tag names. downloadFrom, webhook, outputFilename, and trace are also accepted.

Read bookmarks

import { PDFEngines } from "chromiumly";

const bookmarksBuffer = await PDFEngines.readBookmarks([
  "path/to/file_1.pdf",
  "path/to/file_2.pdf",
]);

Returns a JSON buffer containing bookmarks for each input file. Optional webhook, output ({ outputFilename?, trace? }), and downloadFrom can be passed as the 2nd–4th positional arguments.

Write bookmarks

import { PDFEngines } from "chromiumly";

const updated = await PDFEngines.writeBookmarks({
  files: ["path/to/file_1.pdf"],
  bookmarks: [
    {
      title: "Chapter 1",
      page: 1,
      children: [],
    },
  ],
});

bookmarks accepts either a list applied to all files or a filename-to-list map. downloadFrom, webhook, outputFilename, and trace are also accepted — see Request tracing.