chromiumly
Version:
A lightweight Typescript library that interacts with Gotenberg's different modules to convert a variety of document formats to PDF files.
69 lines • 4.05 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.MarkdownScreenshot = void 0;
const common_1 = require("../../common");
const screenshot_utils_1 = require("../utils/screenshot.utils");
const screenshot_1 = require("./screenshot");
const main_config_1 = require("../../main.config");
/**
* Class representing a Markdown screenshot that extends the base Screenshot class.
* This class is used to screenshots HTML with markdown content using Gotenberg service.
*
* @extends Screenshot
*/
class MarkdownScreenshot extends screenshot_1.Screenshot {
/**
* Creates an instance of MarkdownScreenshot.
* Initializes the Screenshot with the Markdown screenshot route.
*/
constructor() {
super(main_config_1.ChromiumRoute.MARKDOWN);
}
/**
* Screenshots HTML with markdown.
*
* @param {Object} options - Screenshot options.
* @param {PathLikeOrReadStream} options.html - PathLike or ReadStream of the HTML content to be screenshoted.
* @param {PathLikeOrReadStream} options.markdown - PathLike or ReadStream of the Markdown content to be screenshoted.
* @param {ImageProperties} [options.properties] - Image properties for the screenshot.
* @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the screenshot.
* @param {string} [options.waitDelay] - Delay before the screenshot process starts.
* @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the screenshot.
* @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the screenshot.
* @param {number []} [options.failOnHttpStatusCodes] - Whether to fail on HTTP status code.
* @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during screenshot.
* @param {boolean} [options.skipNetworkIdleEvent] - Whether to skip network idle event.
* @param {boolean} [options.optimizeForSpeed] - Whether to optimize for speed.
* @param {DownloadFrom} [options.downloadFrom] - Download a file from a URL. It must return a Content-Disposition header with a filename parameter.
* @param {number[]} [options.failOnResourceHttpStatusCodes] - Whether to fail on resource HTTP status code.
* @param {boolean} [options.failOnResourceLoadingFailed] - Whether to fail on resource loading failed.
* @param {boolean} [options.generateDocumentOutline] - Whether to generate document outline.
* @returns {Promise<Buffer>} A Promise resolving to the image buffer.
*/
async capture({ html, markdown, properties, emulatedMediaType, waitDelay, waitForExpression, extraHttpHeaders, failOnHttpStatusCodes, failOnConsoleExceptions, skipNetworkIdleEvent, optimizeForSpeed, downloadFrom, failOnResourceHttpStatusCodes, failOnResourceLoadingFailed, generateDocumentOutline, userPassword, ownerPassword, embeds }) {
const data = new FormData();
await common_1.GotenbergUtils.addFile(data, html, 'index.html');
await common_1.GotenbergUtils.addFile(data, markdown, 'file.md');
await screenshot_utils_1.ScreenshotUtils.customize(data, {
properties,
emulatedMediaType,
waitDelay,
waitForExpression,
extraHttpHeaders,
failOnHttpStatusCodes,
failOnConsoleExceptions,
failOnResourceHttpStatusCodes,
failOnResourceLoadingFailed,
skipNetworkIdleEvent,
optimizeForSpeed,
downloadFrom,
generateDocumentOutline,
userPassword,
ownerPassword,
embeds
});
return common_1.GotenbergUtils.fetch(this.endpoint, data, main_config_1.Chromiumly.getGotenbergApiBasicAuthUsername(), main_config_1.Chromiumly.getGotenbergApiBasicAuthPassword(), main_config_1.Chromiumly.getCustomHttpHeaders());
}
}
exports.MarkdownScreenshot = MarkdownScreenshot;
//# sourceMappingURL=markdown.screenshot.js.map