PDF to HTML Node.js Reference
Availability: API client version >= 5.4.0
class PdfToHtmlClient
All setter methods return PdfToHtmlClient object unless specified otherwise.
Constructor
function PdfToHtmlClient(userName, apiKey)
Constructor for the Pdfcrowd API client.
userName
Your username at Pdfcrowd.
function convertUrl(url, callbacks)
Convert a PDF.
url
The address of the PDF 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
-
sendGenericHttpResponse(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 a PDF and write the result to a local file.
url
The address of the PDF to convert.
The supported protocols are http:// and https://.
filePath
The output file path.
The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.
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
-
sendGenericHttpResponse(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.
The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.
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
-
sendGenericHttpResponse(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.
The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.
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
-
sendGenericHttpResponse(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.
The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.
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.
General Options
function setPdfPassword(password)
Password to open the encrypted PDF file.
password
The input PDF password.
function setScaleFactor(factor)
Set the scaling factor (zoom) for the main page area.
factor
The percentage value.
Must be a positive integer number.
Default: 100
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 setImageMode(mode)
Specifies where the images are stored.
mode
The image storage mode.
Default: embed
function setCssMode(mode)
Specifies where the style sheets are stored.
mode
The style sheet storage mode.
Default: embed
function setFontMode(mode)
Specifies where the fonts are stored.
mode
The font storage mode.
Default: embed
function isZippedOutput()
A helper method to determine if the output file is a zip archive. The output of the conversion may be either an HTML file or a zip file containing the HTML and its external assets.
Returns
-
bool - True if the conversion output is a zip file, otherwise False.
function setForceZip(value)
Enforces the zip output format.
value
Set to true to get the output as a zip archive.
Default: false
Set the HTML title. The title from the input PDF is used by default.
function setSubject(subject)
Set the HTML subject. The subject from the input PDF is used by default.
subject
The HTML subject.
function setAuthor(author)
Set the HTML author. The author from the input PDF is used by default.
function setKeywords(keywords)
Associate keywords with the HTML document. Keywords from the input PDF are used by default.
keywords
The string containing the keywords.
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.
Get the job id.
Returns
-
string - The unique job identifier.
Get the number of pages in the output document.
Get the size of the output in bytes.
Returns
-
int - The count of bytes.
Get the version details.
Returns
-
string - API version, converter version, and client version.
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.
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.
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.
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 setUserAgent(agent)
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/5.14.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.
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