Adds Typescript definitions

.gitignore

@@ -8,7 +8,7 @@ npm-debug.log*
 .eslintcache
 
 # build output
-lib
+lib/index.*
 
 # tests
 **/build

lib/index.d.ts

@@ -0,0 +1,22 @@
+import Metalsmith from "metalsmith";
+
+export default initMetadata;
+export type Options = {
+  [key: string]: string;
+};
+/**
+ * A Metalsmith plugin to load global metadata from files
+ *
+ * @example
+ * ```js
+ * // inside metalsmith.source()
+ * metalsmith.use(metadata({ 'config': 'src/config.json' }))
+ * // inside metalsmith.directory()
+ * metalsmith.use(metadata({ 'config': 'config.json' }))
+ * // target a keypath
+ * metalsmith.use(metadata({ 'config.nav.items': 'navitems.yaml' }))
+ * ```
+ * @param {Options} options
+ * @returns {import('metalsmith').Plugin}
+ */
+declare function initMetadata(options?: Options): Metalsmith.Plugin;

package.json

@@ -33,6 +33,7 @@
     "lib/index.js",
     "lib/index.cjs"
   ],
+  "types": "lib/index.d.ts",
   "scripts": {
     "changelog": "auto-changelog -u date --commit-limit false --ignore-commit-pattern '^((dev|chore|ci):|Release)'",
     "coverage": "nyc report --reporter=text-lcov > ./coverage.info",