chromiumly
Version:
A lightweight Typescript library that interacts with Gotenberg's different modules to convert a variety of document formats to PDF files.
32 lines (31 loc) • 1.66 kB
TypeScript
import { ImageProperties, ScreenshotOptions } from './../interfaces/screenshot.types';
import { PathLikeOrReadStream } from '../../common';
/**
* Utility class for handling common tasks related to screenshot.
*/
export declare class ScreenshotUtils {
/**
* Adds page properties to the FormData object based on the provided imageProperties.
*
* @param {FormData} data - The FormData object to which page properties will be added.
* @param {ImageProperties} imageProperties - The page properties to be added to the FormData.
*/
static addImageProperties(data: FormData, imageProperties: ImageProperties): void;
/**
* Adds files to the FormData object with a custom field name.
*
* @param {PathLikeOrReadStream[]} files - An array of files to be added to the FormData.
* @param {FormData} data - The FormData object to which files will be added.
* @param {string} fieldName - The field name to use when appending files (e.g., 'files', 'embeds').
* @returns {Promise<void>} A Promise that resolves once the files have been added.
*/
static addFilesWithFieldName(files: PathLikeOrReadStream[], data: FormData, fieldName: string): Promise<void>;
/**
* Customizes the FormData object based on the provided screenshot options.
*
* @param {FormData} data - The FormData object to be customized.
* @param {ScreenshotOptions} options - The screenshot options to apply to the FormData.
* @returns {Promise<void>} A Promise that resolves once the customization is complete.
*/
static customize(data: FormData, options: ScreenshotOptions): Promise<void>;
}