Merge pull request #29 from kratos-42/enhancement/module-declaration-…

…file Add module declaration file
seegno · Feb 3, 2022 · 7904ebc · 7904ebc
2 parents bb7da97 + 4c9d558
commit 7904ebc
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1 @@
+**/*.d.ts
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,8 @@
+import { Model } from 'objection';
+
+interface Options {
+  field?: string;
+  generateGuid?: () => string | number;
+}
+
+export default function(options?: Options): <T extends typeof Model>(ClassModel: T) => T;
diff --git a/package.json b/package.json
@@ -20,6 +20,7 @@
     "type": "git",
     "url": "https://github.com/seegno/objection-guid.git"
   },
+  "types": "index.d.ts",
   "scripts": {
     "changelog": "github_changelog_generator --no-issues --header-label='# Changelog' --future-release=v$npm_config_future_release && sed -i '' -e :a -e '$d;N;2,4ba' -e 'P;D' CHANGELOG.md",
     "cover": "jest --coverage --forceExit",