diff --git a/package.json b/package.json index a42162e..112bfe1 100644 --- a/package.json +++ b/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" diff --git a/types/index.d.ts b/types/index.d.ts new file mode 100644 index 0000000..a0a3fe5 --- /dev/null +++ b/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 { + criteria: Omit; + options: { + limit?: number, + skip?: number, + sort?: object + }; + link: Function + } + + export function queryToMongo(query: T, options?: QueryToMongoOptions): QueryToMongoResult; + +} \ No newline at end of file