chromiumly
Version:
A lightweight Typescript library that interacts with Gotenberg's different modules to convert a variety of document formats to PDF files.
40 lines (39 loc) • 2.9 kB
TypeScript
import { UrlScreenshotOptions } from '../interfaces/screenshot.types';
import { Screenshot } from './screenshot';
/**
* Class representing a URL screenshot that extends the base screenshot class.
* This class is used to screenshot a URL using Gotenberg service.
*
* @extends Screenshot
*/
export declare class UrlScreenshot extends Screenshot {
/**
* Creates an instance of UrlScreenshot.
* Initializes the screenshot with the URL screenshot route.
*/
constructor();
/**
* Screenshots URL.
*
* @param {Object} options - Screenshot options.
* @param {string} options.url - The URL of the content to be screenshoted
* @param {ImageProperties} [options.properties] - Image properties for the screenshot.
* @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the screenshot.
* @param {EmulatedMediaFeature[]} [options.emulatedMediaFeatures] - Override CSS media features (e.g. prefers-color-scheme).
* @param {string} [options.waitDelay] - Delay before the screenshot process starts.
* @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the screenshot.
* @param {string} [options.waitForSelector] - CSS selector 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 {number[]} [options.failOnResourceHttpStatusCodes] - Whether to fail on resource HTTP status code.
* @param {string[]} [options.ignoreResourceHttpStatusDomains] - Domains to exclude from resource HTTP status code checks.
* @param {boolean} [options.failOnResourceLoadingFailed] - Whether to fail on resource loading failed.
* @param {boolean} [options.skipNetworkIdleEvent] - Whether to skip network idle event.
* @param {boolean} [options.optimizeForSpeed] - Whether to optimize for speed.
* @param {Cookie[]} options.cookies - Cookies to be written.
* @param {boolean} [options.generateDocumentOutline] - Whether to generate document outline.
* @returns {Promise<Buffer>} A Promise resolving to the image buffer.
*/
capture({ url, properties, emulatedMediaType, emulatedMediaFeatures, waitDelay, waitForExpression, waitForSelector, extraHttpHeaders, failOnHttpStatusCodes, failOnConsoleExceptions, failOnResourceHttpStatusCodes, ignoreResourceHttpStatusDomains, failOnResourceLoadingFailed, skipNetworkIdleEvent, skipNetworkAlmostIdleEvent, optimizeForSpeed, cookies, downloadFrom, webhook, generateDocumentOutline, userPassword, ownerPassword, embeds }: UrlScreenshotOptions): Promise<Buffer>;
}