Add Typescript types & option JSdocs

metalsmith · Aug 5, 2022 · 5e97ec2 · 5e97ec2
1 parent c26f5f3
commit 5e97ec2
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/package.json b/package.json
@@ -45,6 +45,7 @@
  "lib",
  "CHANGELOG.md"
  ],
+ "types": "lib/types.d.ts",
  "scripts": {
  "changelog": "auto-changelog -u --starting-version v1.1.1 --commit-limit false --ignore-commit-pattern '(dev|ci|chore|Release|Merge)'",
  "coverage": "nyc report --reporter=text-lcov > ./coverage.info",
@@ -53,7 +54,7 @@
  "lint": "eslint --fix .",
  "lint:check": "eslint --fix-dry-run .",
  "release": "release-it .",
- "build": "microbundle --target node --no-sourcemap -f cjs,esm --strict",
+ "build": "microbundle --target node --no-sourcemap -f cjs,esm --strict --types",
  "pretest": "npm run build",
  "test": "nyc mocha"
  },

diff --git a/src/index.js b/src/index.js
@@ -1,7 +1,7 @@
 /**
  * @typedef {Object} Options
- * @property {Boolean} [default=false]
- * @property {Boolean} [include=true]
+ * @property {Boolean} [default=false] Consider files without `draft` key drafts. Defaults to `false`.
+ * @property {Boolean} [include=false] Include drafts in the build output. Defaults to `false`.
  */
 
 const defaultOptions = {