pdfreader

https://www.npmjs.com/package/pdfreader
Admin
pdfreader is a Node.js module for reading text and parsing tables from PDF files with automatic...
Tokens:2,719
Snippets:46
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install and Test pdfreader via CLI

Source: https://www.npmjs.com/package/pdfreader?activeTab=code

Commands to clone the repository, install dependencies, run tests, and execute the parser on a sample file.

```bash
git clone https://github.com/adrienjoly/npm-pdfreader.git
cd npm-pdfreader
npm install
npm test
node parse.js test/sample.pdf
```

--------------------------------

### Install pdfreader package

Source: https://www.npmjs.com/package/pdfreader?activeTab=dependencies

Command to install the pdfreader package via npm.

```bash
npm i pdfreader
```

--------------------------------

### Install pdfreader as a Dependency

Source: https://www.npmjs.com/package/pdfreader?activeTab=code

Command to add the package to an existing Node.js project.

```bash
npm install pdfreader
```

--------------------------------

### Define and use rule-based data extraction

Source: https://www.npmjs.com/package/pdfreader?activeTab=dependencies

Utilize the Rule class to define custom data extraction strategies. This example demonstrates extracting values using regular expressions, parsing table data, and accumulating values after a heading. The processItem function applies these rules to parsed PDF items.

```javascript
const processItem = Rule.makeItemProcessor([
  Rule.on(/^Hello \"(.*)\"$/)
    .extractRegexpValues()
    .then(displayValue),
  Rule.on(/^Value\:/)
    .parseNextItemValue()
    .then(displayValue),
  Rule.on(/^c1$/).parseTable(3).then(displayTable),
  Rule.on(/^Values\:/)
    .accumulateAfterHeading()
    .then(displayValue),
]);
new PdfReader().parseFileItems("test/sample.pdf", (err, item) => {
  if (err) console.error(err);
  else processItem(item);
});
```

--------------------------------

### Set Navigator UserAgent for pdfreader in Node.js

Source: https://www.npmjs.com/package/pdfreader?activeTab=code

Include these instructions before requiring the pdfreader module to prevent 'userAgent' errors in Node.js environments. This simulates a browser environment for the module.

```javascript
global.navigator = {
  userAgent: "node",
};

window.navigator = {
  userAgent: "node",
};
```

--------------------------------

### Parse PDF from Buffer

Source: https://www.npmjs.com/package/pdfreader?activeTab=code

Reading a PDF file into a buffer and parsing it using the parseBuffer method.

```javascript
import fs from "fs";
import { PdfReader } from "pdfreader";

fs.readFile("test/sample.pdf", (err, pdfBuffer) => {
  // pdfBuffer contains the file content
  new PdfReader().parseBuffer(pdfBuffer, (err, item) => {
    if (err) console.error("error:", err);
    else if (!item) console.warn("end of buffer");
    else if (item.text) console.log(item.text);
  });
});
```

--------------------------------

### Parse Password-Protected PDF

Source: https://www.npmjs.com/package/pdfreader?activeTab=code

Usage of the PdfReader constructor to provide a password for protected PDF files.

```javascript
new PdfReader({ password: "YOUR_PASSWORD" }).parseFileItems(
  "test/sample-with-password.pdf",
  function (err, item) {
    if (err) console.error(err);
    else if (!item) console.warn("end of file");
    else if (item.text) console.log(item.text);
  }
);
```

--------------------------------

### Extract Data Using Rules

Source: https://www.npmjs.com/package/pdfreader?activeTab=code

Defining extraction rules with the Rule class to process specific patterns during PDF parsing.

```javascript
const processItem = Rule.makeItemProcessor([
  Rule.on(/^Hello "(.*)"$/)
    .extractRegexpValues()
    .then(displayValue),
  Rule.on(/^Value\:/)
    .parseNextItemValue()
    .then(displayValue),
  Rule.on(/^c1$/).parseTable(3).then(displayTable),
  Rule.on(/^Values\:/)
    .accumulateAfterHeading()
    .then(displayValue),
]);
new PdfReader().parseFileItems("test/sample.pdf", (err, item) => {
  if (err) console.error(err);
  else processItem(item);
});
```

--------------------------------

### Parse PDF File Items

Source: https://www.npmjs.com/package/pdfreader?activeTab=code

Basic usage of the PdfReader class to parse a PDF file and log text items.

```javascript
import { PdfReader } from "pdfreader";

new PdfReader().parseFileItems("test/sample.pdf", (err, item) => {
  if (err) console.error("error:", err);
  else if (!item) console.warn("end of file");
  else if (item.text) console.log(item.text);
});
```
Tokens:
Raw