Merge pull request #44 from rwalle61/add-typescript-declaration-file

add TypeScript declaration file
WaleedAshraf · Sep 30, 2021 · 8e2f4ca · 8e2f4ca
2 parents ba4b3b9 + a32c839
commit 8e2f4ca
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,15 @@
+declare module 'asyncapi-validator' {
+  type Validator = {
+    validate: (
+      key: string,
+      payload: unknown,
+      channel: string,
+      operation: 'publish' | 'subscribe',
+    ) => void;
+  };
+
+  const fromSource: (
+    path: string | Record<string, unknown>,
+    options: { msgIdentifier: string; ignoreArray?: boolean },
+  ) => Promise<Validator>;
+}
diff --git a/package.json b/package.json
@@ -3,6 +3,7 @@
   "version": "3.1.0",
   "description": "message validator through asyncapi schema",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "test": "jest",
     "lint": "./node_modules/.bin/eslint ./"