Skip to content

Commit

Permalink
chore: prep release
Browse files Browse the repository at this point in the history
  • Loading branch information
@Fdawgs
Fdawgs committed Nov 3, 2020
1 parent 302ed17 commit a85885d
Show file tree
Hide file tree
Showing 7 changed files with 578 additions and 506 deletions.
6 changes: 3 additions & 3 deletions API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ Converts a PDF file to PNG/JPEG/TIFF/PDF/PS/EPS/SVG.
| Param | Type | Description |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| file | <code>string</code> | Filepath of the PDF file to read. |
| [outputFile] | <code>string</code> | Filepath of the file to output the results to. Can be set to `'-'` to write output to stdout. Using stdout is not valid with image formats unless `options.singleFile` is set to `true`. If not set then the output filename will be derived from the PDF file name. |
| [outputFile] | <code>string</code> | Filepath of the file to output the results to. If `undefined` then will write output to stdout. Using stdout is not valid with image formats unless `options.singleFile` is set to `true`. If not set then the output filename will be derived from the PDF file name. |
| [options] | <code>object</code> | Object containing options to pass to binary. |
| [options.antialias] | <code>&#x27;default&#x27;</code> \| <code>&#x27;none&#x27;</code> \| <code>&#x27;gray&#x27;</code> \| <code>&#x27;subpixel&#x27;</code> \| <code>&#x27;fast&#x27;</code> \| <code>&#x27;good&#x27;</code> \| <code>&#x27;best&#x27;</code> | Set the cairo antialias option used for text and drawing in image files (or rasterized regions in vector output). |
| [options.cropBox] | <code>boolean</code> | Uses the crop box rather than media box when generating the files (PNG/JPEG/TIFF only). |
Expand Down Expand Up @@ -349,7 +349,7 @@ Converts a PDF file to PostScript (PS).
| Param | Type | Description |
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| file | <code>string</code> | Filepath of the PDF file to read. |
| [outputFile] | <code>string</code> | Filepath of the file to output the results to. Can be set to `'-'` to write output to stdout. |
| [outputFile] | <code>string</code> | Filepath of the file to output the results to. If `undefined` then will write output to stdout. |
| [options] | <code>object</code> | Object containing options to pass to binary. |
| [options.antialias] | <code>&#x27;yes&#x27;</code> \| <code>&#x27;no&#x27;</code> | Enable anti-aliasing on rasterization, accepts `yes` or `no`. |
| [options.binary] | <code>boolean</code> | Write binary data in Level 1 PostScript. By default, pdftops writes hex-encoded data in Level 1 PostScript. Binary data is non-standard in Level 1 PostScript but reduces the file size and can be useful when Level 1 PostScript is required only for its restricted use of PostScript operators. |
Expand Down Expand Up @@ -401,7 +401,7 @@ Converts a PDF file to TXT.
| Param | Type | Description |
| -------------------------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| file | <code>string</code> | Filepath of the PDF file to read. |
| [outputFile] | <code>string</code> | Filepath of the file to output the results to. Can be set to `'-'` to write output to stdout. |
| [outputFile] | <code>string</code> | Filepath of the file to output the results to. If `undefined` then will write output to stdout. |
| [options] | <code>object</code> | Object containing options to pass to binary. |
| [options.boundingBoxXhtml] | <code>boolean</code> | Generate an XHTML file containing bounding box information for each word in the file. |
| [options.boundingBoxXhtmlLayout] | <code>boolean</code> | Generate an XHTML file containing bounding box information for each block, line, and word in the file. |
Expand Down
20 changes: 20 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
## 2.0.0 (2020-11-03)

- docs: enable TypeScript definition generation for all methods ([cceecc8](https://github.com/Fdawgs/node-poppler/commit/cceecc8)) , thanks to @arthurdenner
- docs(index): correct stdout usage ([be0bb49](https://github.com/Fdawgs/node-poppler/commit/be0bb49))
- docs(readme): add note about macos binaries ([41c7e1e](https://github.com/Fdawgs/node-poppler/commit/41c7e1e))
- test(index): correct param orders for function calls ([e075a7b](https://github.com/Fdawgs/node-poppler/commit/e075a7b))
- build(deps-dev): bump dev dependencies ([c450c04](https://github.com/Fdawgs/node-poppler/commit/c450c04))
- build(travis): update osx image ([0c043db](https://github.com/Fdawgs/node-poppler/commit/0c043db))
- feat(index): add typescript definition file ([d82df8b](https://github.com/Fdawgs/node-poppler/commit/d82df8b))
- feat(lib): update poppler win32 binaries from 20.10.0 to 20.11.0 ([bc5478e](https://github.com/Fdawgs/node-poppler/commit/bc5478e))
- refactor(index): reorder parameters for all functions ([ead466e](https://github.com/Fdawgs/node-poppler/commit/ead466e))
- chore: add TypeScript config to generate definition ([c5b4858](https://github.com/Fdawgs/node-poppler/commit/c5b4858)), thanks to @arthurdenner
- chore(scripts): do not lint ts and tsx files ([b1e8426](https://github.com/Fdawgs/node-poppler/commit/b1e8426))

### BREAKING CHANGE

- optional `options` object parameter for all functions has been moved to the end. i.e. `Poppler.pdfToText(options, file, outputFile)` is now `Poppler.pdfToText(file, outputFile, options)`.

This allows for easier use of the functions as users no longer have to place an undefined parameter if no options are provided. `Poppler.pdfToText(undefined, file, outputFile)` can now be called instead like `Poppler.pdfToText(file, outputFile)`.

## <small>1.8.5 (2020-10-14)</small>

- build: create codeql-analysis.yml workflow file ([7346f8f](https://github.com/Fdawgs/node-poppler/commit/7346f8f))
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ npm install node-poppler
node-poppler's test scripts use yarn commands.

### Linux and macOS/Darwin support

Windows and macOS/Darwin binaries are provided with this repository.
For Linux users, you will need to download the `poppler-data` and `poppler-utils` binaries separately.

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "node-poppler",
"version": "1.8.5",
"version": "2.0.0",
"description": "Asynchronous node.js wrapper for the Poppler PDF rendering library",
"keywords": [
"async",
Expand Down
Loading

0 comments on commit a85885d

Please sign in to comment.