IPublisherDocumentExportPdfOptions
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Options for exporting a document to PDF.
export interface IPublisherDocumentExportPdfOptions
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) (Optional) File name for the export, without the extension. | ||
number | (ALPHA) (Optional) Override the default export result polling timeout (in milliseconds). |
Property details
IPublisherDocumentExportPdfOptions.filenamepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
File name for the export, without the extension.
filename?: string;
IPublisherDocumentExportPdfOptions.timeoutpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Override the default export result polling timeout (in milliseconds).
timeout?: number;
Remarks
If not specified, there is still a default timeout applied.