Add types

Author: loris

package.json

@@ -4,8 +4,10 @@
   "description": "Convert query parameters from API urls to MongoDB queries",
   "main": "dist/cjs/index.js",
   "files": [
-    "dist/"
+    "dist/",
+    "./types.d.ts"
   ],
+  "types": "./types.d.ts",
   "scripts": {
     "build": "babel ./src/index.js --out-file ./dist/cjs/index.js",
     "coverage": "nyc npm test && nyc report --reporter=html",

types.d.ts

@@ -0,0 +1,29 @@
+declare module 'api-query-params' {
+  export type AqpQuery = {
+    filter: Record<string, any>;
+    skip: number;
+    limit: number;
+    sort: Record<string, number>;
+    projection: Record<string, number>;
+  };
+
+  function aqp(
+    query: string | Record<string, string>,
+    opt?: {
+      skipKey?: string;
+      limitKey?: string;
+      projectionKey?: string;
+      sortKey?: string;
+      filterKey?: string;
+      populationKey?: string;
+
+      blacklist?: string[];
+      whitelist?: string[];
+
+      castParams?: unknown;
+      casters?: unknown;
+    }
+  ): AqpQuery;
+
+  export default aqp;
+}