Skip to content

Commit

Permalink
chore(index): correct syntax for union types
Browse files Browse the repository at this point in the history
  • Loading branch information
Fdawgs committed Feb 7, 2025
1 parent 61f44d3 commit 7e15571
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ class Poppler {
/**
* @author Frazer Smith
* @description Lists the fonts used in a PDF file along with various information for each font.
* @param {Buffer|string} file - PDF file as Buffer, or filepath of the PDF file to read.
* @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
* @param {object} [options] - Object containing options to pass to binary.
* @param {number} [options.firstPageToExamine] - Specifies the first page to examine.
* @param {number} [options.lastPageToExamine] - Specifies the last page to examine.
Expand Down Expand Up @@ -306,7 +306,7 @@ class Poppler {
/**
* @author Frazer Smith
* @description Saves images from a PDF file as PPM, PBM, PNG, TIFF, JPEG, JPEG2000, or JBIG2 files.
* @param {Buffer|string} file - PDF file as Buffer, or filepath of the PDF file to read.
* @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
* @param {string} [outputPrefix] - Filename prefix of output files.
* @param {object} [options] - Object containing options to pass to binary.
* @param {boolean} [options.allFiles] - Write JPEG, JPEG2000, JBIG2, and CCITT images in their native format.
Expand Down Expand Up @@ -411,7 +411,7 @@ class Poppler {
/**
* @author Frazer Smith
* @description Prints the contents of the `Info` dictionary from a PDF file.
* @param {Buffer|string} file - PDF file as Buffer, or filepath of the PDF file to read.
* @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
* @param {object} [options] - Object containing options to pass to binary.
* @param {number} [options.firstPageToConvert] - First page to print.
* @param {number} [options.lastPageToConvert] - Last page to print.
Expand Down Expand Up @@ -839,7 +839,7 @@ class Poppler {
/**
* @author Frazer Smith
* @description Converts a PDF file to HTML.
* @param {Buffer|string} file - PDF file as Buffer, or filepath of the PDF file to read.
* @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
* @param {string} [outputFile] - Filepath of the file to output the results to.
* If `undefined` then Poppler will use the directory and name of the original file
* and create a new file, with `-html` appended to the end of the filename.
Expand Down Expand Up @@ -968,7 +968,7 @@ class Poppler {
* @description Converts a PDF file to colour image files in Portable Pixmap (PPM) format,
* grayscale image files in Portable Graymap (PGM) format, or monochrome image files
* in Portable Bitmap (PBM) format.
* @param {Buffer|string} file - PDF file as Buffer, or filepath of the PDF file to read.
* @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
* @param {string} outputPath - Filepath to output the results to.
* @param {object} [options] - Object containing options to pass to binary.
* @param {('no'|'yes')} [options.antialiasFonts] - Enable or disable font anti-aliasing.
Expand Down Expand Up @@ -1164,7 +1164,7 @@ class Poppler {
/**
* @author Frazer Smith
* @description Converts a PDF file to PostScript (PS).
* @param {Buffer|string} file - PDF file as Buffer, or filepath of the PDF file to read.
* @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
* @param {string} [outputFile] - Filepath of the file to output the results to.
* If `undefined` then will write output to stdout.
* @param {object} [options] - Object containing options to pass to binary.
Expand Down Expand Up @@ -1406,7 +1406,7 @@ class Poppler {
/**
* @author Frazer Smith
* @description Converts a PDF file to TXT.
* @param {Buffer|string} file - PDF file as Buffer, or filepath of the PDF file to read.
* @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
* @param {string} [outputFile] - Filepath of the file to output the results to.
* If `undefined` then will write output to stdout.
* @param {object} [options] - Object containing options to pass to binary.
Expand Down

0 comments on commit 7e15571

Please sign in to comment.