PDF to Image / Node.js Reference

class PdfToImageClient

All setter methods return PdfToImageClient object unless specified otherwise.

Constructor

function PdfToImageClient(userName, apiKey)
Constructor for the Pdfcrowd API client.
userName
Your username at Pdfcrowd.
apiKey
Your API key.

Conversion Input

function convertUrl(url, callbacks)
Convert an image.
url
The address of the image to convert.
The supported protocols are http:// and https://.
callbacks
The object that defines the following functions:
  • data(readStream) - called when the output data can be read from readStream
  • error(message, statusCode) - called when an error occurs
  • end() - called when the conversion finishes
The client library provides 2 helper functions that can be used here:
  • saveToFile(filePath[, callback]) - saves the output data to a file
    • filePath - the output file path
    • callback(err, filePath) - called when the conversion finishes
  • sendImageInHttpResponse(response, contentType, fileName[, disposition]) - sends the generated image in an HTTP response
    • response - the response object
    • contentType - the response content type
    • fileName - the desired file name
    • disposition - the response content disposition, can be "attachment" or "inline", the default is "attachment". 
function convertUrlToFile(url, filePath, callback)
Convert an image and write the result to a local file.
url
The address of the image to convert.
The supported protocols are http:// and https://.
filePath
The output file path.
callback
The callback(error, filePath) function is called when the conversion finishes. The error object is present if an error occurred, filePath is the output file path. 
function convertFile(file, callbacks)
Convert a local file.
file
The path to a local file to convert.
The file must exist and not be empty.
callbacks
The object that defines the following functions:
  • data(readStream) - called when the output data can be read from readStream
  • error(message, statusCode) - called when an error occurs
  • end() - called when the conversion finishes
The client library provides 2 helper functions that can be used here:
  • saveToFile(filePath[, callback]) - saves the output data to a file
    • filePath - the output file path
    • callback(err, filePath) - called when the conversion finishes
  • sendImageInHttpResponse(response, contentType, fileName[, disposition]) - sends the generated image in an HTTP response
    • response - the response object
    • contentType - the response content type
    • fileName - the desired file name
    • disposition - the response content disposition, can be "attachment" or "inline", the default is "attachment". 
function convertFileToFile(file, filePath, callback)
Convert a local file and write the result to a local file.
file
The path to a local file to convert.
The file must exist and not be empty.
filePath
The output file path.
callback
The callback(error, filePath) function is called when the conversion finishes. The error object is present if an error occurred, filePath is the output file path. 
function convertRawData(data, callbacks)
Convert raw data.
data
The raw content to be converted.
callbacks
The object that defines the following functions:
  • data(readStream) - called when the output data can be read from readStream
  • error(message, statusCode) - called when an error occurs
  • end() - called when the conversion finishes
The client library provides 2 helper functions that can be used here:
  • saveToFile(filePath[, callback]) - saves the output data to a file
    • filePath - the output file path
    • callback(err, filePath) - called when the conversion finishes
  • sendImageInHttpResponse(response, contentType, fileName[, disposition]) - sends the generated image in an HTTP response
    • response - the response object
    • contentType - the response content type
    • fileName - the desired file name
    • disposition - the response content disposition, can be "attachment" or "inline", the default is "attachment". 
function convertRawDataToFile(data, filePath, callback)
Convert raw data to a file.
data
The raw content to be converted.
filePath
The output file path.
callback
The callback(error, filePath) function is called when the conversion finishes. The error object is present if an error occurred, filePath is the output file path. 
function convertStream(inStream, callbacks)
Convert the contents of an input stream.
inStream
The input stream with source data.
callbacks
The object that defines the following functions:
  • data(readStream) - called when the output data can be read from readStream
  • error(message, statusCode) - called when an error occurs
  • end() - called when the conversion finishes
The client library provides 2 helper functions that can be used here:
  • saveToFile(filePath[, callback]) - saves the output data to a file
    • filePath - the output file path
    • callback(err, filePath) - called when the conversion finishes
  • sendImageInHttpResponse(response, contentType, fileName[, disposition]) - sends the generated image in an HTTP response
    • response - the response object
    • contentType - the response content type
    • fileName - the desired file name
    • disposition - the response content disposition, can be "attachment" or "inline", the default is "attachment". 
function convertStreamToFile(inStream, filePath, callback)
Convert the contents of an input stream and write the result to a local file.
inStream
The input stream with source data.
filePath
The output file path.
callback
The callback(error, filePath) function is called when the conversion finishes. The error object is present if an error occurred, filePath is the output file path.

Conversion Format

function setOutputFormat(outputFormat)
The format of the output file.
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.
password
The input PDF password. 
function setPrintPageRange(pages)
Set the page range to print.
pages
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 first 3 pages are printed.
    setPrintPageRange("-3")
  • Pages 3, 6, 7, 8 and 9 are printed.
    setPrintPageRange("3,6-9") 
function setDpi(dpi)
Set the output graphics DPI.
Availability: API client >= 5.16.0, converter >= 20.10. See versioning.
dpi
The DPI value.
Default: 144 
function isZippedOutput()
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.
Returns
  • bool - True if the conversion output is a zip archive, otherwise False. 
function setForceZip(value)
Enforces the zip output format.
value
Set to true to get the output as a zip archive.
Default: false 
function setUseCropbox(value)
Use the crop box rather than media box.
value
Set to true to use crop box.
Default: false 
function setCropAreaX(x)
Set the top left X coordinate of the crop area in points.
x
Must be a positive integer number or 0.
Default: 0
Example:
  • setCropAreaX(100) 
function setCropAreaY(y)
Set the top left Y coordinate of the crop area in points.
y
Must be a positive integer number or 0.
Default: 0
Example:
  • setCropAreaY(100) 
function setCropAreaWidth(width)
Set the width of the crop area in points.
width
Must be a positive integer number or 0.
Default: PDF page width.
Example:
  • setCropAreaWidth(100) 
function setCropAreaHeight(height)
Set the height of the crop area in points.
height
Must be a positive integer number or 0.
Default: PDF page height.
Example:
  • setCropAreaHeight(100) 
function setCropArea(x, y, width, height)
Set the crop area. It allows to extract just a part of a PDF page.
x
Set the top left X coordinate of the crop area in points.
Must be a positive integer number or 0.
Default: 0
y
Set the top left Y coordinate of the crop area in points.
Must be a positive integer number or 0.
Default: 0
width
Set the width of the crop area in points.
Must be a positive integer number or 0.
Default: PDF page width.
height
Set the height of the crop area in points.
Must be a positive integer number or 0.
Default: PDF page height. 
function setUseGrayscale(value)
Generate a grayscale image.
value
Set to true to generate a grayscale image.
Default: false

Miscellaneous

function setDebugLog(value)
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
value
Set to true to enable the debug logging.
Default: false 
function getDebugLogUrl()
Get the URL of the debug log for the last conversion.
Returns
  • string - The link to the debug log. 
function getRemainingCreditCount()
Get the number of conversion credits available in your account.
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.
Returns
  • int - The number of credits. 
function getConsumedCreditCount()
Get the number of credits consumed by the last conversion.
Returns
  • int - The number of credits. 
function getJobId()
Get the job id.
Returns
  • string - The unique job identifier. 
function getPageCount()
Get the number of pages in the output document.
Returns
  • int - The page count. 
function getOutputSize()
Get the size of the output in bytes.
Returns
  • int - The count of bytes. 
function getVersion()
Get the version details.
Returns
  • string - API version, converter version, and client version. 
function setTag(tag)
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
tag
A string with the custom tag.
Example:
  • setTag("client-1234") 
function setHttpProxy(proxy)
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy
The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • setHttpProxy("myproxy.com:8080")
  • setHttpProxy("113.25.84.10:33333") 
function setHttpsProxy(proxy)
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy
The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • setHttpsProxy("myproxy.com:443")
  • setHttpsProxy("113.25.84.10:44333")

API Client Options

function setUseHttp(value)
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
value
Set to true to use HTTP.
Default: false

Warning

Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.

function setClientUserAgent(agent)
Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
Availability: API client >= 6.4.0 See versioning.
agent
The user agent string. 
function setUserAgent(agent)
Deprecated Replaced with: setClientUserAgent()
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
agent
The user agent string.
Default: pdfcrowd_nodejs_client/6.4.0 (https://pdfcrowd.com) 
function setProxy(host, port, userName, password)
Specifies an HTTP proxy that the API client library will use to connect to the internet.
host
The proxy hostname.
port
The proxy port.
userName
The username.
password
The password. 
function setRetryCount(count)
Specifies the number of automatic retries when the 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.
count
Number of retries.
Default: 1
Example:
  • setRetryCount(3)