Skip to content
This repository was archived by the owner on May 1, 2025. It is now read-only.

Commit 2a2095b

Browse files
author
Hans Kristian Flaatten
committed
docs(options): add default value to constructor options
1 parent eb60e36 commit 2a2095b

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,14 @@ var MongoQS = require('mongo-querystring');
7171

7272
### new MongoQS(`object` options)
7373

74-
* `Array` ops - list of supported operators
75-
* `object` alias - query param aliases
76-
* `object` blacklist - blacklisted query params
77-
* `object` whitelist - whitelisted query params
78-
* `object` custom - custom query params
74+
* `Array` ops - list of supported operators (default: `['!', '^', '$', '~', '>', '<', '$in']`)
75+
* `object` alias - query param aliases (default: `{}`)
76+
* `object` blacklist - blacklisted query params (default: `{}`)
77+
* `object` whitelist - whitelisted query params (default: `{}`)
78+
* `object` custom - custom query params (default: `{}`)
7979
* `object` string - string parsing
80-
* `boolean` toBoolean - parse `"true"`, `"false"` string to booleans
81-
* `boolean` toNumber - parse string integer and float values to numbers
80+
* `boolean` toBoolean - parse `"true"`, `"false"` string to booleans (default: `true`)
81+
* `boolean` toNumber - parse string integer and float values to numbers (default: `true`)
8282

8383
#### Bult in custom queries
8484

0 commit comments

Comments
 (0)