ci: add typescript compilation step

.github/workflows/ci.yml

@@ -22,6 +22,8 @@ jobs:
                   node-version: 14.x
             - name: Install
               run: yarn --frozen-lockfile
+            - name: Compile TypeScript Definition File
+              run: yarn tsc --strict
             - name: Run ESLint
               run: yarn lint
             - name: Run Prettier

CONTRIBUTING.md

@@ -27,10 +27,6 @@ After cloning and installing all the dependencies, there are several commands av
 -   `yarn jest` - Runs Jest over all tests in src directory
 -   `yarn test` - Runs `yarn lint` and `yarn jest` together
 
-### Production Workflow
-
--   `yarn start` - Runs a production version. No live reload.
-
 ## Pull Request Checklist
 
 Prior to submitting a pull request back to the main repository, please make sure you have completed the following steps:

package.json

@@ -34,7 +34,7 @@
 	},
 	"scripts": {
 		"changelog": "conventional-changelog -p @commitlint/config-conventional -s -i CHANGELOG.md && prettier CHANGELOG.md --write",
-		"doc": "tsc && jsdoc2md src/index.js > API.md && prettier API.md --write",
+		"doc": "tsc --strict && jsdoc2md src/index.js > API.md && prettier API.md --write",
 		"dupe-check": "yarn jsinspect ./src",
 		"jest": "cross-env NODE_ENV=test jest --detectOpenHandles --runInBand",
 		"jest-coverage": "cross-env NODE_ENV=test jest --coverage --runInBand",

src/index.d.ts

@@ -4,7 +4,7 @@ export class Poppler {
 	 * Useful for Linux users who have poppler-utils binaries already installed.
 	 */
 	constructor(binPath?: string | undefined);
-	popplerPath: string;
+	popplerPath: string | undefined;
 	/**
 	 * @author Frazer Smith
 	 * @description Embeds files (attachments) into a PDF file.