PDF to Text Node.js Reference

This reference describes the Node.js SDK's calling conventions, errors, helpers, and client methods for the PDF to Text API. See the installation instructions for setup and the guide for usage examples.

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

MethodsResultWhen it resolves
Content methods Buffer All text 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.

Decode the UTF-8 text with buffer.toString('utf8').

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:

HandlerMeaning
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, throws TypeError. 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.

OperationReturn typeDescription
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.
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 disposition defaults to 'attachment'; use 'inline' to display the output in the browser.
Errors:
Conversion errors are sent as plain text in the HTTP response.

class PdfToTextClient

All setter methods return PdfToTextClient object unless specified otherwise.

Constructor

function PdfToTextClient(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:
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:
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.

General Options

function setPdfPassword(password)

The 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")

function setNoLayout(value)

Ignore the original PDF layout. Extract text in reading order without preserving column structure or positioning. Simpler output for pure text extraction.

TypeScript:
setNoLayout(value: boolean): this;
Parameter:
  • value (boolean) - Set to true to ignore the layout.
    Default:
    false

function setEol(eol)

The end-of-line convention for the text output.

TypeScript:
setEol(eol: string): this;
Parameter:
  • eol
    Allowed Values:
    • unix — Unix convention "LF" is used.
    • dos — DOS convention "CR LF" is used.
    • mac — Mac convention "CR" is used.
    Default:
    unix

function setPageBreakMode(mode)

Specify the page break mode for the text output.

TypeScript:
setPageBreakMode(mode: string): this;
Parameter:
  • mode
    Allowed Values:
    • none — No page breaks are inserted.
    • default — The standard page break code "FF" is used.
    • custom — A custom page break is used.
    Default:
    none

function setCustomPageBreak(pageBreak)

Specify the custom page break.

TypeScript:
setCustomPageBreak(pageBreak: string): this;
Parameter:
  • pageBreak - String to insert between the pages.
Examples:
  • Clear text between pages: setCustomPageBreak("END OF PAGE")
  • Visual separator with line break: setCustomPageBreak("----my page break----\n")

function setParagraphMode(mode)

Specify the paragraph detection mode. Enable to format output with proper paragraph breaks. Use "none" for raw text, or detection modes for formatted output.

TypeScript:
setParagraphMode(mode: string): this;
Parameter:
  • mode
    Allowed Values:
    • none — No paragraph detection.
    • bounding-box — Paragraph detection based on line bounding boxes.
    • characters — Paragraph detection based on the number of characters in the line.
    Default:
    none

function setLineSpacingThreshold(threshold)

Set the maximum line spacing when the paragraph detection mode is enabled.

TypeScript:
setLineSpacingThreshold(threshold: string): this;
Parameter:
  • threshold
    Constraint:
    • The value must be a positive integer percentage.
    Default:
    10%

function setRemoveHyphenation(value)

Remove the hyphen character from the end of lines.

TypeScript:
setRemoveHyphenation(value: boolean): this;
Parameter:
  • value (boolean) - Set to true to remove hyphens.
    Default:
    false

function setRemoveEmptyLines(value)

Remove empty lines from the text output.

TypeScript:
setRemoveEmptyLines(value: boolean): this;
Parameter:
  • value (boolean) - Set to true to remove empty lines.
    Default:
    false

function setCropAreaX(x)

Set the top left X coordinate of the crop area in points.

TypeScript:
setCropAreaX(x: number): this;
Parameter:
  • x (number)
    Constraint:
    • Must be a positive integer or 0.
Example:
  • Start extraction at 1.4 inches from left: setCropAreaX(100)

function setCropAreaY(y)

Set the top left Y coordinate of the crop area in points.

TypeScript:
setCropAreaY(y: number): this;
Parameter:
  • y (number)
    Constraint:
    • Must be a positive integer or 0.
Example:
  • Start extraction at 1.4 inches from top: setCropAreaY(100)

function setCropAreaWidth(width)

Set the width of the crop area in points.

TypeScript:
setCropAreaWidth(width: number): this;
Parameter:
  • width (number)
    Constraint:
    • Must be a positive integer or 0.
    Default:
    PDF page width.
Example:
  • Extract narrow 1.4 inch width: setCropAreaWidth(100)

function setCropAreaHeight(height)

Set the height of the crop area in points.

TypeScript:
setCropAreaHeight(height: number): this;
Parameter:
  • height (number)
    Constraint:
    • Must be a positive integer or 0.
    Default:
    PDF page height.
Example:
  • Extract small 1.4 inch height: setCropAreaHeight(100)

function setCropArea(x, y, width, height)

Set the crop area. It allows you to extract just a part of a PDF page.

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 points.
    Constraint:
    • Must be a positive integer or 0.
  • y (number) - Set the top left Y coordinate of the crop area in points.
    Constraint:
    • Must be a positive integer or 0.
  • width (number) - Set the width of the crop area in points.
    Constraint:
    • Must be a positive integer or 0.
    Default:
    PDF page width.
  • height (number) - Set the height of the crop area in points.
    Constraint:
    • Must be a positive integer or 0.
    Default:
    PDF page height.

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 to true to 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")

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")

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")

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 to true to 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)