summaryrefslogtreecommitdiff
path: root/package.json
diff options
context:
space:
mode:
authorJustin Wernick <justin@worthe-it.co.za>2023-06-09 13:07:05 +0200
committerJustin Wernick <justin@worthe-it.co.za>2023-06-09 13:07:05 +0200
commitc3557a37cc9e4d23db0f14f669e72c7aaff5d4c1 (patch)
treeb1cd8e74b0ba2563c3f53a005841ee34672e0576 /package.json
parentb94eaaa950223b6bae163aaf32123c3d7d4169a4 (diff)
Add JSDoc comments to the public interface
Diffstat (limited to 'package.json')
-rw-r--r--package.json4
1 files changed, 3 insertions, 1 deletions
diff --git a/package.json b/package.json
index 6550f3e..bc15702 100644
--- a/package.json
+++ b/package.json
@@ -5,7 +5,8 @@
"main": "south-african-id-parser.js",
"scripts": {
"pretest": "eslint ./",
- "test": "mocha"
+ "test": "mocha",
+ "docs": "jsdoc *.js --destination dist/docs"
},
"keywords": [
"South Africa",
@@ -30,6 +31,7 @@
"devDependencies": {
"chai": "^4.3.7",
"eslint": "^8.42.0",
+ "jsdoc": "^4.0.2",
"mocha": "^10.2.0"
}
}