SDK behavior
Calling conventions and results
Conversion methods such as
convertUrl() and convertUrlToFile() support Promises and callbacks
in Node.js SDK 7 and later. Omitting the callback argument or passing
undefined returns a Promise. Handle it with await or
.then()/.catch().
Supplying a valid callback selects callback mode and returns undefined.
Promise results
| Methods | Result | When it resolves |
|---|---|---|
| Content methods | Buffer |
All image output has been received. |
*ToFile |
Supplied file path | The output has been written and the file closed. |
*ToStream (Promise-only) |
Readable |
The response is available. Await a pipeline or finish async iteration to receive all output and observe later failures. |
The SDK has no cancellation API. Closing a local stream does not guarantee that a conversion running on the service stops.
Callbacks
Content methods accept a callbacks object with required
data and error handlers and an optional
end handler:
| Handler | Meaning |
|---|---|
data(readStream) |
Receives the response stream. |
error(message, statusCode, cause) |
Reports conversion failure. Status and underlying cause may be absent. |
end() |
The conversion response is complete. Wait separately for your destination to finish writing. |
File methods accept callback(error, filePath): success calls
callback(null, filePath) after the file closes; failure passes the SDK error.
Callback helpers can write a file or send an HTTP response.
Errors
- Promise mode: conversion failures and invalid inputs reject the Promise.
- Stream output: handle both Promise rejection and errors while consuming the stream.
- Synchronous errors: an invalid callback argument, including
null, throwsTypeError. Constructors and setters remain synchronous; callback mode retains synchronous validation errors.
Conversion failures use pdfcrowd.Pdfcrowd.Error, a native
Error subclass. Its cause holds an underlying error when available.
See error details
for status, reason, and message accessors.
Error object
pdfcrowd.Pdfcrowd.Error extends the native Error class.
Its cause holds an underlying error when available.
The table lists the SDK error object's methods and string representation.
| Operation | Return type | Description |
|---|---|---|
getStatusCode |
number | undefined |
The HTTP status code, or undefined when unavailable. |
getReasonCode |
number |
The PDFCrowd reason code, or -1 when unavailable. |
getMessage |
string |
The error message. |
getDocumentationLink |
string |
A URL with more information about the error, or an empty string when unavailable. |
toString |
string |
The complete error text, including status and reason codes and a documentation link when present. |
Callback helpers
These functions return a callbacks object for content conversion methods.
pdfcrowd.saveToFile(filePath, callback)
Writes the conversion output to a file.
- Callback:
- The optional
callback(error, filePath)reports failure or completion after the file closes.
pdfcrowd.sendGenericHttpResponse(response, contentType, fileName, disposition)
Sends the output in an HTTP response with the supplied content type and filename.
- Defaults:
- Optional
dispositiondefaults to'attachment'; use'inline'to display the output in the browser. - Errors:
- Conversion errors are sent as plain text in the HTTP response.
pdfcrowd.sendImageInHttpResponse(response, contentType, fileName, disposition)
Sends image output using the supplied content type and filename.
- Behavior:
- Same as
sendGenericHttpResponse.
class PdfToImageClient
All setter methods return PdfToImageClient object unless specified otherwise.
Constructor
function PdfToImageClient(userName, apiKey)
Constructor for the PDFCrowd API client. Initialize a new instance of the conversion client with your PDFCrowd account credentials.
You must provide both your username and API key. This establishes the authenticated connection for all subsequent conversion operations.
- TypeScript:
-
constructor(userName: string, apiKey: string); - Parameters:
-
-
userName- Your username at PDFCrowd. -
apiKey- Your API key.
-
Conversion Input
convertUrl
Convert a PDF from a URL.
Use this as the primary method for converting web content, online documents, or any publicly accessible URL to the desired output format. Returns the conversion result as a byte array for further processing or direct use.
- Promise:
client.convertUrl(url)- Callback:
client.convertUrl(url, callbacks)- TypeScript:
-
convertUrl(url: string, callbacks?: undefined): Promise<Buffer>;
convertUrl(url: string, callbacks: Callbacks): void; - Parameters:
-
-
url- The address of the PDF to convert.- Constraint:
-
- Supported protocols are http:// and https://.
-
callbacks- For callback mode; see Calling conventions and results.
-
- Returns:
- Promise<Buffer> - The complete conversion output. See Calling conventions and results.
convertUrlToStream
Run the conversion and return its output as a readable stream.
- Promise:
client.convertUrlToStream(url)- TypeScript:
-
convertUrlToStream(url: string): Promise<Readable>; - Parameter:
-
-
url- The address of the PDF to convert.- Constraint:
-
- Supported protocols are http:// and https://.
-
- Returns:
- Promise<Readable> - The readable conversion output. See Calling conventions and results.
convertUrlToFile
Convert a PDF from a URL and save the conversion result directly to a local file.
Use this for simple file-based workflows, batch processing, or when you need to persist conversion output to disk.
- Promise:
client.convertUrlToFile(url, filePath)- Callback:
client.convertUrlToFile(url, filePath, callback)- TypeScript:
-
convertUrlToFile(url: string, filePath: string, callback?: undefined): Promise<string>;
convertUrlToFile(url: string, filePath: string, callback: FileCallback): void; - Parameters:
-
-
url- The address of the PDF to convert.- Constraint:
-
- Supported protocols are http:// and https://.
-
filePath- The output file path. -
callback- For callback mode; see Calling conventions and results.
-
- Returns:
- Promise<string> - The supplied output file path. See Calling conventions and results.
convertFile
Convert a local file to the desired output format.
Use this for processing files already on your system, converting uploaded documents, or batch processing local content. Returns the conversion result as a byte array for in-memory processing.
- Promise:
client.convertFile(file)- Callback:
client.convertFile(file, callbacks)- TypeScript:
-
convertFile(file: string, callbacks?: undefined): Promise<Buffer>;
convertFile(file: string, callbacks: Callbacks): void; - Parameters:
-
-
file- The path to a local file to convert.
- Constraint:
-
- The file must exist and not be empty.
-
callbacks- For callback mode; see Calling conventions and results.
-
- Returns:
- Promise<Buffer> - The complete conversion output. See Calling conventions and results.
convertFileToStream
Run the conversion and return its output as a readable stream.
- Promise:
client.convertFileToStream(file)- TypeScript:
-
convertFileToStream(file: string): Promise<Readable>; - Parameter:
-
-
file- The path to a local file to convert.
- Constraint:
-
- The file must exist and not be empty.
-
- Returns:
- Promise<Readable> - The readable conversion output. See Calling conventions and results.
convertFileToFile
Convert a local file and save the conversion result to another local file.
Use this for file-based batch processing, document transformation workflows, or when both input and output are file-based.
- Promise:
client.convertFileToFile(file, filePath)- Callback:
client.convertFileToFile(file, filePath, callback)- TypeScript:
-
convertFileToFile(file: string, filePath: string, callback?: undefined): Promise<string>;
convertFileToFile(file: string, filePath: string, callback: FileCallback): void; - Parameters:
-
-
file- The path to a local file to convert.
- Constraint:
-
- The file must exist and not be empty.
-
filePath- The output file path. -
callback- For callback mode; see Calling conventions and results.
-
- Returns:
- Promise<string> - The supplied output file path. See Calling conventions and results.
convertRawData
Convert raw binary data to the desired output format.
Use this for processing binary content, handling file uploads as byte arrays, or when working with data from external APIs. Provides maximum flexibility for binary data conversions.
- Promise:
client.convertRawData(data)- Callback:
client.convertRawData(data, callbacks)- TypeScript:
-
convertRawData(data: Buffer | string, callbacks?: undefined): Promise<Buffer>;
convertRawData(data: Buffer | string, callbacks: Callbacks): void; - Parameters:
-
-
data(Buffer | string) - The raw content to be converted. -
callbacks- For callback mode; see Calling conventions and results.
-
- Returns:
- Promise<Buffer> - The complete conversion output. See Calling conventions and results.
convertRawDataToStream
Run the conversion and return its output as a readable stream.
- Promise:
client.convertRawDataToStream(data)- TypeScript:
-
convertRawDataToStream(data: Buffer | string): Promise<Readable>; - Parameter:
-
-
data(Buffer | string) - The raw content to be converted.
-
- Returns:
- Promise<Readable> - The readable conversion output. See Calling conventions and results.
convertRawDataToFile
Convert raw binary data and save the conversion result to a local file.
Use this for processing binary uploads and persisting the output, handling data from external sources, or when working with byte array inputs that need file-based storage.
- Promise:
client.convertRawDataToFile(data, filePath)- Callback:
client.convertRawDataToFile(data, filePath, callback)- TypeScript:
-
convertRawDataToFile(data: Buffer | string, filePath: string, callback?: undefined): Promise<string>;
convertRawDataToFile(data: Buffer | string, filePath: string, callback: FileCallback): void; - Parameters:
-
-
data(Buffer | string) - The raw content to be converted. -
filePath- The output file path. -
callback- For callback mode; see Calling conventions and results.
-
- Returns:
- Promise<string> - The supplied output file path. See Calling conventions and results.
convertStream
Convert content from an input stream to the desired output format.
Use this when integrating with I/O pipelines, processing data from network streams or file handles, or when the source data is provided as a stream by your application.
The input stream is buffered in memory before upload.
- Promise:
client.convertStream(inStream)- Callback:
client.convertStream(inStream, callbacks)- TypeScript:
-
convertStream(inStream: Readable, callbacks?: undefined): Promise<Buffer>;
convertStream(inStream: Readable, callbacks: Callbacks): void; - Parameters:
-
-
inStream(Readable) - The input stream with source data.
-
callbacks- For callback mode; see Calling conventions and results.
-
- Returns:
- Promise<Buffer> - The complete conversion output. See Calling conventions and results.
convertStreamToStream
Run the conversion and return its output as a readable stream.
The input stream is buffered in memory before upload.
- Promise:
client.convertStreamToStream(inStream)- TypeScript:
-
convertStreamToStream(inStream: Readable): Promise<Readable>; - Parameter:
-
-
inStream(Readable) - The input stream with source data.
-
- Returns:
- Promise<Readable> - The readable conversion output. See Calling conventions and results.
convertStreamToFile
Convert content from an input stream and save the conversion result to a local file.
Use this when processing streaming uploads that need to be saved, handling network data sources with file-based output, or building services that accept stream input and produce file output.
The input stream is buffered in memory before upload.
- Promise:
client.convertStreamToFile(inStream, filePath)- Callback:
client.convertStreamToFile(inStream, filePath, callback)- TypeScript:
-
convertStreamToFile(inStream: Readable, filePath: string, callback?: undefined): Promise<string>;
convertStreamToFile(inStream: Readable, filePath: string, callback: FileCallback): void; - Parameters:
-
-
inStream(Readable) - The input stream with source data.
-
filePath- The output file path. -
callback- For callback mode; see Calling conventions and results.
-
- Returns:
- Promise<string> - The supplied output file path. See Calling conventions and results.
Conversion Format
function setOutputFormat(outputFormat)
The output file format.
- TypeScript:
-
setOutputFormat(outputFormat: string): this; - Parameter:
-
-
outputFormat- Allowed Values:
-
-
png -
jpg -
gif -
tiff -
bmp -
ico -
ppm -
pgm -
pbm -
pnm -
psb -
pct -
ras -
tga -
sgi -
sun -
webp
-
- Default:
-
png
-
General Options
function setPdfPassword(password)
Password to open the encrypted PDF file.
- TypeScript:
-
setPdfPassword(password: string): this; - Parameter:
-
-
password- The input PDF password.
-
function setPrintPageRange(pages)
Set the page range to print.
- TypeScript:
-
setPrintPageRange(pages: string): this; - Parameter:
-
-
pages- Constraint:
-
- A comma separated list of page numbers or ranges.
-
- Examples:
-
-
Just the second page is printed:
setPrintPageRange("2") -
The first and the third page are printed:
setPrintPageRange("1,3") -
Everything except the first page is printed:
setPrintPageRange("2-") -
Just the first 3 pages are printed:
setPrintPageRange("-3") -
Pages 3, 6, 7, 8 and 9 are printed:
setPrintPageRange("3,6-9")
-
Just the second page is printed:
function setDpi(dpi)
Set the output graphics DPI. Higher values increase quality but also file size. Use 72-96 for screen, 150 for web, 300 for print.
- TypeScript:
-
setDpi(dpi: number): this; - Availability:
- API client >= 5.16.0, converter >= 20.10. See versioning.
- Parameter:
-
-
dpi(number) - The DPI value.- Default:
-
144
-
function isZippedOutput() { return bool; }
A helper method to determine if the output file from a conversion process is a zip archive. The conversion output can be either a single image file or a zip file containing one or more image files. This method should be called after the conversion has been successfully completed.
- TypeScript:
-
isZippedOutput(): boolean; - Returns:
-
bool
-
Trueif the conversion output is a zip archive, otherwiseFalse.
function setForceZip(value)
Enforce the zip output format. Get output as zip even for single images. Useful for consistent file handling in automated workflows.
- TypeScript:
-
setForceZip(value: boolean): this; - Parameter:
-
-
value(boolean) - Set totrueto get the output as a zip archive.- Default:
-
false
-
function setUseCropbox(value)
Use the crop box rather than media box. Respects PDF crop settings for trimmed output. Use when PDFs have defined crop boundaries.
- TypeScript:
-
setUseCropbox(value: boolean): this; - Parameter:
-
-
value(boolean) - Set totrueto use crop box.- Default:
-
false
-
function setCropAreaX(x)
Set the top left X coordinate of the crop area in pixels at the selected DPI, measured from the left edge of the rendered page.
- TypeScript:
-
setCropAreaX(x: number): this; - Parameter:
-
-
x(number)- Constraint:
-
- Must be a positive integer or 0.
-
- Example:
-
-
Start crop 100 pixels from the left edge:
setCropAreaX(100)
-
Start crop 100 pixels from the left edge:
function setCropAreaY(y)
Set the top left Y coordinate of the crop area in pixels at the selected DPI, measured from the top edge of the rendered page.
- TypeScript:
-
setCropAreaY(y: number): this; - Parameter:
-
-
y(number)- Constraint:
-
- Must be a positive integer or 0.
-
- Example:
-
-
Start crop 100 pixels from the top edge:
setCropAreaY(100)
-
Start crop 100 pixels from the top edge:
function setCropAreaWidth(width)
Set the width of the crop area in pixels at the selected DPI.
- TypeScript:
-
setCropAreaWidth(width: number): this; - Parameter:
-
-
width(number)- Constraint:
-
- Must be a positive integer or 0.
- Default:
-
PDF page width.
-
- Example:
-
-
Set crop width to 100 pixels:
setCropAreaWidth(100)
-
Set crop width to 100 pixels:
function setCropAreaHeight(height)
Set the height of the crop area in pixels at the selected DPI.
- TypeScript:
-
setCropAreaHeight(height: number): this; - Parameter:
-
-
height(number)- Constraint:
-
- Must be a positive integer or 0.
- Default:
-
PDF page height.
-
- Example:
-
-
Set crop height to 100 pixels:
setCropAreaHeight(100)
-
Set crop height to 100 pixels:
function setCropArea(x, y, width, height)
Set the crop area to extract part of a PDF page. Coordinates and dimensions are in pixels at the selected DPI, measured from the top left of the rendered page. When changing DPI, scale all four values by the same ratio to keep the same region.
- TypeScript:
-
setCropArea(x: number, y: number, width: number, height: number): this; - Parameters:
-
-
x(number) - Set the top left X coordinate of the crop area in pixels at the selected DPI, measured from the left edge of the rendered page.- Constraint:
-
- Must be a positive integer or 0.
-
y(number) - Set the top left Y coordinate of the crop area in pixels at the selected DPI, measured from the top edge of the rendered page.- Constraint:
-
- Must be a positive integer or 0.
-
width(number) - Set the width of the crop area in pixels at the selected DPI.- Constraint:
-
- Must be a positive integer or 0.
- Default:
-
PDF page width.
-
height(number) - Set the height of the crop area in pixels at the selected DPI.- Constraint:
-
- Must be a positive integer or 0.
- Default:
-
PDF page height.
-
function setUseGrayscale(value)
Generate a grayscale image.
- TypeScript:
-
setUseGrayscale(value: boolean): this; - Parameter:
-
-
value(boolean) - Set totrueto generate a grayscale image.- Default:
-
false
-
Miscellaneous
function setDebugLog(value)
Turn on debug logging to troubleshoot conversion issues. Details about the conversion process, including resource loading, rendering steps, and error messages are stored in the debug log. Use this when conversions fail or produce unexpected results. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
- TypeScript:
-
setDebugLog(value: boolean): this; - Parameter:
-
-
value(boolean) - Set totrueto enable debug logging.- Default:
-
false
-
function getDebugLogUrl() { return string; }
Get the URL of the debug log for the last conversion.
- TypeScript:
-
getDebugLogUrl(): string | null; - Returns:
- string - The link to the debug log.
function getRemainingCreditCount() { return int; }
Get the number of conversion credits available in your account. Use this to monitor your credit usage and implement alerts before running out of credits.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
- TypeScript:
-
getRemainingCreditCount(): number; - Returns:
- int - The number of credits.
function getConsumedCreditCount() { return int; }
Get the number of credits consumed by the last conversion. Use this to track costs per conversion, especially for complex documents or operations that may consume multiple credits.
- TypeScript:
-
getConsumedCreditCount(): number; - Returns:
- int - The number of credits.
function getJobId() { return string; }
Get the unique job ID for the conversion. Use this to track conversions in your logs, correlate with debug logs, or reference specific conversions when contacting support.
- TypeScript:
-
getJobId(): string; - Returns:
- string - The unique job identifier.
function getPageCount() { return int; }
Get the number of pages in the output document. Use this to validate conversion results, calculate pagination for user interfaces, or track document complexity metrics.
- TypeScript:
-
getPageCount(): number; - Returns:
- int - The page count.
function getOutputSize() { return int; }
Get the size of the output document in bytes. Use this to check file sizes before delivery, implement size-based quotas, or optimize storage allocation.
- TypeScript:
-
getOutputSize(): number; - Returns:
- int - The count of bytes.
function getVersion() { return string; }
Get the version details including API version, converter version, and client library version. Use this for debugging, logging, or ensuring compatibility when reporting issues.
- TypeScript:
-
getVersion(): string; - Returns:
- string - API version, converter version, and client version.
function setTag(tag)
Tag the conversion with a custom value for tracking and analytics. Use this to categorize conversions by customer ID, document type, or business unit. The tag appears in conversion statistics. A value longer than 32 characters is cut off.
- TypeScript:
-
setTag(tag: string): this; - Parameter:
-
-
tag- A string with the custom tag.
-
- Example:
-
-
Track job in analytics:
setTag("client-1234")
-
Track job in analytics:
function setHttpProxy(proxy)
A proxy server used by the conversion process for accessing the source URLs with HTTP scheme. This can help circumvent regional restrictions or provide limited access to your intranet.
- TypeScript:
-
setHttpProxy(proxy: string): this; - Parameter:
-
-
proxy- Constraint:
-
- The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
-
- Examples:
-
-
Corporate proxy server:
setHttpProxy("myproxy.com:8080") -
Direct IP proxy connection:
setHttpProxy("113.25.84.10:33333")
-
Corporate proxy server:
function setHttpsProxy(proxy)
A proxy server used by the conversion process for accessing the source URLs with HTTPS scheme. This can help circumvent regional restrictions or provide limited access to your intranet.
- TypeScript:
-
setHttpsProxy(proxy: string): this; - Parameter:
-
-
proxy- Constraint:
-
- The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
-
- Examples:
-
-
Secure proxy for HTTPS:
setHttpsProxy("myproxy.com:443") -
Direct secure proxy IP:
setHttpsProxy("113.25.84.10:44333")
-
Secure proxy for HTTPS:
API Client Options
function setUseHttp(value)
Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API.
- TypeScript:
-
setUseHttp(value: boolean): this; - Parameter:
-
-
value(boolean) - Set totrueto use HTTP.- Default:
-
false
-
function setClientUserAgent(agent)
Specify the User-Agent HTTP header that the client library will use when interacting with the API.
- TypeScript:
-
setClientUserAgent(agent: string): this; - Availability:
- API client >= 6.4.0 See versioning.
- Parameter:
-
-
agent- The user agent string.
-
function setProxy(host, port, userName, password)
Specify an HTTP proxy that the API client library will use to connect to the internet.
- TypeScript:
-
setProxy(host: string, port: number, userName: string, password: string): this; - Parameters:
-
-
host- The proxy hostname. -
port(number) - The proxy port. -
userName- The username. -
password- The password.
-
function setRetryCount(count)
Specify the number of automatic retries when a 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
- TypeScript:
-
setRetryCount(count: number): this; - Parameter:
-
-
count(number) - Number of retries.- Default:
-
1
-
- Example:
-
-
Retry failed requests three times:
setRetryCount(3)
-
Retry failed requests three times: