Merge pull request #33 from pineromarcos/types

package.json

@@ -3,6 +3,7 @@
   "version": "0.10.2",
   "description": "Convert query parameters into mongo query criteria and options.",
   "main": "index.js",
+  "types": "types/index.d.ts",
   "repository": {
     "type": "git",
     "url": "http://github.com/pbatey/query-to-mongo"

types/index.d.ts

@@ -0,0 +1,20 @@
+declare module 'query-to-mongo' {
+  interface QueryToMongoOptions {
+    maxLimit?: string | number
+    ignore?: 'fields' | 'omit' | 'sort' | 'offset' | 'limit'
+    parser?: object
+  }
+
+  interface QueryToMongoResult<T> {
+    criteria: Omit<T, 'limit' | 'offset' | 'sort'>;
+    options: {
+      limit?: number,
+      skip?: number,
+      sort?: object
+    };
+    link: Function
+  }
+
+  export function queryToMongo<T>(query: T, options?: QueryToMongoOptions): QueryToMongoResult<T>;
+
+}