Troubleshooting TypeError: pdfjs.getDocument is not a function with pdfjs-dist

Are you encountering the error message "TypeError: pdfjs.getDocument is not a function" when trying to use the pdfjs-dist library? Don't worry, this error is common and can be fixed with a few simple steps. In this article, we will go over the causes of this error and how to troubleshoot it. By the end, you will be able to use the pdfjs-dist library without any issues.

Understanding the Error

The error message "TypeError: pdfjs.getDocument is not a function" indicates that the getDocument function is not available in the pdfjs object. This function is used to load and display a PDF document in the browser. If it is not available, the library will not be able to display the PDF document, resulting in the error message.

There are two main reasons why the getDocument function may not be available:

• The pdfjs-dist library is not properly loaded.
• The version of the pdfjs-dist library being used is outdated and does not include the getDocument function.

Troubleshooting the Error

To troubleshoot the error, follow these steps:

1. Check if the pdfjs-dist library is properly loaded. Make sure that the library is loaded before the code that uses the getDocument function. You can check if the library is loaded by adding the following code to your HTML file:

   if (!pdfjsLib) {
     console.error('pdfjs-dist library not loaded');
   }
   

   If the library is not loaded, add the following script tag to your HTML file:

   <script src="https://mozilla.github.io/pdf.js/build/pdf.js"></script>
   

2. Check if the version of the pdfjs-dist library being used is outdated. The getDocument function was added in version 2.0.0 of the library. If you are using an older version, update the library to the latest version.

   To check the version of the library, add the following code to your HTML file:

   console.log(pdfjsLib.version);
   

   If the version is older than 2.0.0, update the library by replacing the script tag with the following:

   <script src="https://mozilla.github.io/pdf.js/build/pdf.js"></script>
   

3. If the library is properly loaded and up-to-date, check if the getDocument function is being called correctly. Make sure that the function is called on the pdfjs object and that the correct arguments are passed to the function.

   Here is an example of how to use the getDocument function:

   pdfjsLib.getDocument('example.pdf').promise.then(function(pdf) {
     // Do something with the PDF document.
   });
   

The error message "TypeError: pdfjs.getDocument is not a function" can be caused by the pdfjs-dist library not being properly loaded or the version of the library being outdated. By following the troubleshooting steps outlined in this article, you will be able to use the pdfjs-dist library without any issues. If you continue to experience problems, refer to the official documentation for further assistance.

References