mquery - npm Package Compare versions

Comparing version 3.1.1 to 3.1.2

History.md

@@ -0,1 +1,5 @@
+3.1.2 / 2018-08-01
+==================
+ * chore: move eslint to devDependencies #110 [jakesjews](https://github.com/jakesjews)
+
 3.1.1 / 2018-07-30
@@ -2,0 +6,0 @@ ==================

lib/utils.js

@@ -224,3 +224,3 @@ 'use strict';
  *
- * @param {String} readConcern
+ * @param {String|Object} concern
  */
@@ -227,0 +227,0 @@

package.json

 {
   "name": "mquery",
-  "version": "3.1.1",
+  "version": "3.1.2",
   "description": "Expressive query building for MongoDB",
@@ -21,3 +21,2 @@ "main": "lib/mquery.js",
     "debug": "3.1.0",
-    "eslint": "4.14.0",
     "regexp-clone": "0.0.1",
@@ -27,2 +26,3 @@ "sliced": "1.0.1"
   "devDependencies": {
+    "eslint": "^4.14.0",
     "istanbul": "^0.4.5",
@@ -29,0 +29,0 @@ "mocha": "4.1.0",

README.md

@@ -53,3 +53,3 @@ # mquery
 - [findOneAndUpdate](#findoneandupdate)
-- [findOneAndRemove](#findoneandremove)
+- [findOneAndDelete, findOneAndRemove](#findoneandremove)
 - [distinct](#distinct)
@@ -94,2 +94,3 @@ - [exec](#exec)
 - [hint](#hint)
+- [j](#j)
 - [limit](#limit)
@@ -100,7 +101,9 @@ - [maxScan](#maxscan)
 - [sort](#sort)
-- [read](#read)
-- [readConcern](#readconcern)
+- [read, setReadPreference](#read)
+- [readConcern, r](#readconcern)
 - [slaveOk](#slaveok)
 - [snapshot](#snapshot)
 - [tailable](#tailable)
+- [writeConcern, w](#writeconcern)
+- [wtimeout, wTimeout](#wtimeout)
 
@@ -293,3 +296,4 @@ ## Helpers
 
-Declares this query a _findAndModify_ with remove query. Optionally pass a match clause, options, or callback. If a callback is passed, the query is executed.
+Declares this query a _findAndModify_ with remove query. Alias of findOneAndDelete.
+Optionally pass a match clause, options, or callback. If a callback is passed, the query is executed.
 
@@ -305,2 +309,3 @@ When executed, the first matching document (if found) is modified according to the update document, removed from the collection and passed to the callback.
 ```js
+A.where().findOneAndDelete()
 A.where().findOneAndRemove()
@@ -868,2 +873,23 @@ A.where().findOneAndRemove(match)
 
+### j()
+
+Requests acknowledgement that this operation has been persisted to MongoDB's on-disk journal.
+
+This option is only valid for operations that write to the database:
+
+- `deleteOne()`
+- `deleteMany()`
+- `findOneAndDelete()`
+- `findOneAndUpdate()`
+- `remove()`
+- `update()`
+- `updateOne()`
+- `updateMany()`
+
+Defaults to the `j` value if it is specified in [writeConcern](#writeconcern)
+
+```js
+mquery().j(true);
+```
+
 ### limit()
@@ -954,2 +980,4 @@
 mquery().read('n')  // same as nearest
+
+mquery().setReadPreference('primary') // alias of .read()
 ```
@@ -996,16 +1024,26 @@
 ```js
+// local
 mquery().readConcern('local')
-mquery().readConcern('l')  // same as local
+mquery().readConcern('l')
+mquery().r('l')
 
+// available
 mquery().readConcern('available')
-mquery().readConcern('a')  // same as available
+mquery().readConcern('a')
+mquery().r('a')
 
+// majority
 mquery().readConcern('majority')
-mquery().readConcern('m')  // same as majority
+mquery().readConcern('m')
+mquery().r('m')
 
+// linearizable
 mquery().readConcern('linearizable')
-mquery().readConcern('lz') // same as linearizable
+mquery().readConcern('lz')
+mquery().r('lz')
 
+// snapshot
 mquery().readConcern('snapshot')
-mquery().readConcern('s')  // same as snapshot
+mquery().readConcern('s')
+mquery().r('s')
 ```
@@ -1031,2 +1069,41 @@
 
+### writeConcern()
+
+Sets the writeConcern option for the query.
+
+This option is only valid for operations that write to the database:
+
+- `deleteOne()`
+- `deleteMany()`
+- `findOneAndDelete()`
+- `findOneAndUpdate()`
+- `remove()`
+- `update()`
+- `updateOne()`
+- `updateMany()`
+
+```js
+mquery().writeConcern(0)
+mquery().writeConcern(1)
+mquery().writeConcern({ w: 1, j: true, wtimeout: 2000 })
+mquery().writeConcern('majority')
+mquery().writeConcern('m') // same as majority
+mquery().writeConcern('tagSetName') // if the tag set is 'm', use .writeConcern({ w: 'm' }) instead
+mquery().w(1) // w is alias of writeConcern
+```
+
+##### Write Concern:
+
+writeConcern({ w: `<value>`, j: `<boolean>`, wtimeout: `<number>` }`)
+
+- the w option to request acknowledgement that the write operation has propagated to a specified number of mongod instances or to mongod instances with specified tags
+- the j option to request acknowledgement that the write operation has been written to the journal
+- the wtimeout option to specify a time limit to prevent write operations from blocking indefinitely
+
+Can be break down to use the following syntax:
+
+mquery().w(`<value>`).j(`<boolean>`).wtimeout(`<number>`)
+
+Read more about how to use write concern [here](https://docs.mongodb.com/manual/reference/write-concern/)
+
 ### slaveOk()
@@ -1074,2 +1151,25 @@
 
+### wtimeout()
+
+Specifies a time limit, in milliseconds, for the write concern. If `w > 1`, it is maximum amount of time to
+wait for this write to propagate through the replica set before this operation fails. The default is `0`, which means no timeout.
+
+This option is only valid for operations that write to the database:
+
+- `deleteOne()`
+- `deleteMany()`
+- `findOneAndDelete()`
+- `findOneAndUpdate()`
+- `remove()`
+- `update()`
+- `updateOne()`
+- `updateMany()`
+
+Defaults to `wtimeout` value if it is specified in [writeConcern](#writeconcern)
+
+```js
+mquery().wtimeout(2000)
+mquery().wTimeout(2000)
+```
+
 ## Helpers
@@ -1076,0 +1176,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

245121

increased by3.56%

Dependency count

4

decreased by-20%

Lines of code

6291

increased by2.74%

Number of lines in readme file

1376

increased by7.84%

Worsened metrics

Dev dependency count

4

increased by33.33%

Dependency changes

• - Removedeslint@4.14.0

• - Removedacorn@3.3.05.7.4(transitive)

• - Removedacorn-jsx@3.0.1(transitive)

• - Removedajv@5.5.26.12.6(transitive)

• - Removedajv-keywords@3.5.2(transitive)

• - Removedansi-escapes@3.2.0(transitive)

• - Removedansi-regex@2.1.13.0.1(transitive)

• - Removedansi-styles@2.2.13.2.1(transitive)

• - Removedargparse@1.0.10(transitive)

• - Removedbabel-code-frame@6.26.0(transitive)

• - Removedbalanced-match@1.0.2(transitive)

• - Removedbrace-expansion@1.1.11(transitive)

• - Removedbuffer-from@1.1.2(transitive)

• - Removedcaller-path@0.1.0(transitive)

• - Removedcallsites@0.2.0(transitive)

• - Removedchalk@1.1.32.4.2(transitive)

• - Removedchardet@0.4.2(transitive)

• - Removedcircular-json@0.3.3(transitive)

• - Removedcli-cursor@2.1.0(transitive)

• - Removedcli-width@2.2.1(transitive)

• - Removedco@4.6.0(transitive)

• - Removedcolor-convert@1.9.3(transitive)

• - Removedcolor-name@1.1.3(transitive)

• - Removedconcat-map@0.0.1(transitive)

• - Removedconcat-stream@1.6.2(transitive)

• - Removedcore-util-is@1.0.3(transitive)

• - Removedcross-spawn@5.1.0(transitive)

• - Removeddeep-is@0.1.4(transitive)

• - Removeddoctrine@2.1.0(transitive)

• - Removedescape-string-regexp@1.0.5(transitive)

• - Removedeslint@4.14.0(transitive)

• - Removedeslint-scope@3.7.3(transitive)

• - Removedeslint-visitor-keys@1.3.0(transitive)

• - Removedespree@3.5.4(transitive)

• - Removedesprima@4.0.1(transitive)

• - Removedesquery@1.6.0(transitive)

• - Removedesrecurse@4.3.0(transitive)

• - Removedestraverse@4.3.05.3.0(transitive)

• - Removedesutils@2.0.3(transitive)

• - Removedexternal-editor@2.2.0(transitive)

• - Removedfast-deep-equal@1.1.03.1.3(transitive)

• - Removedfast-json-stable-stringify@2.1.0(transitive)

• - Removedfast-levenshtein@2.0.6(transitive)

• - Removedfigures@2.0.0(transitive)

• - Removedfile-entry-cache@2.0.0(transitive)

• - Removedflat-cache@1.3.4(transitive)

• - Removedfs.realpath@1.0.0(transitive)

• - Removedfunctional-red-black-tree@1.0.1(transitive)

• - Removedglob@7.2.3(transitive)

• - Removedglobals@11.12.0(transitive)

• - Removedgraceful-fs@4.2.11(transitive)

• - Removedhas-ansi@2.0.0(transitive)

• - Removedhas-flag@3.0.0(transitive)

• - Removediconv-lite@0.4.24(transitive)

• - Removedignore@3.3.10(transitive)

• - Removedimurmurhash@0.1.4(transitive)

• - Removedinflight@1.0.6(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedinquirer@3.3.0(transitive)

• - Removedis-fullwidth-code-point@2.0.0(transitive)

• - Removedis-resolvable@1.1.0(transitive)

• - Removedisarray@1.0.0(transitive)

• - Removedisexe@2.0.0(transitive)

• - Removedjs-tokens@3.0.2(transitive)

• - Removedjs-yaml@3.14.1(transitive)

• - Removedjson-schema-traverse@0.3.10.4.1(transitive)

• - Removedjson-stable-stringify-without-jsonify@1.0.1(transitive)

• - Removedlevn@0.3.0(transitive)

• - Removedlodash@4.17.21(transitive)

• - Removedlru-cache@4.1.5(transitive)

• - Removedmimic-fn@1.2.0(transitive)

• - Removedminimatch@3.1.2(transitive)

• - Removedminimist@1.2.8(transitive)

• - Removedmkdirp@0.5.6(transitive)

• - Removedmute-stream@0.0.7(transitive)

• - Removednatural-compare@1.4.0(transitive)

• - Removedobject-assign@4.1.1(transitive)

• - Removedonce@1.4.0(transitive)

• - Removedonetime@2.0.1(transitive)

• - Removedoptionator@0.8.3(transitive)

• - Removedos-tmpdir@1.0.2(transitive)

• - Removedpath-is-absolute@1.0.1(transitive)

• - Removedpath-is-inside@1.0.2(transitive)

• - Removedpluralize@7.0.0(transitive)

• - Removedprelude-ls@1.1.2(transitive)

• - Removedprocess-nextick-args@2.0.1(transitive)

• - Removedprogress@2.0.3(transitive)

• - Removedpseudomap@1.0.2(transitive)

• - Removedpunycode@2.3.1(transitive)

• - Removedreadable-stream@2.3.8(transitive)

• - Removedrequire-uncached@1.0.3(transitive)

• - Removedresolve-from@1.0.1(transitive)

• - Removedrestore-cursor@2.0.0(transitive)

• - Removedrimraf@2.6.3(transitive)

• - Removedrun-async@2.4.1(transitive)

• - Removedrx-lite@4.0.8(transitive)

• - Removedrx-lite-aggregates@4.0.8(transitive)

• - Removedsafe-buffer@5.1.2(transitive)

• - Removedsafer-buffer@2.1.2(transitive)

• - Removedsemver@5.7.2(transitive)

• - Removedshebang-command@1.2.0(transitive)

• - Removedshebang-regex@1.0.0(transitive)

• - Removedsignal-exit@3.0.7(transitive)

• - Removedslice-ansi@1.0.0(transitive)

• - Removedsprintf-js@1.0.3(transitive)

• - Removedstring-width@2.1.1(transitive)

• - Removedstring_decoder@1.1.1(transitive)

• - Removedstrip-ansi@3.0.14.0.0(transitive)

• - Removedstrip-json-comments@2.0.1(transitive)

• - Removedsupports-color@2.0.05.5.0(transitive)

• - Removedtable@4.0.3(transitive)

• - Removedtext-table@0.2.0(transitive)

• - Removedthrough@2.3.8(transitive)

• - Removedtmp@0.0.33(transitive)

• - Removedtype-check@0.3.2(transitive)

• - Removedtypedarray@0.0.6(transitive)

• - Removeduri-js@4.4.1(transitive)

• - Removedutil-deprecate@1.0.2(transitive)

• - Removedwhich@1.3.1(transitive)

• - Removedword-wrap@1.2.5(transitive)

• - Removedwrappy@1.0.2(transitive)

• - Removedwrite@0.2.1(transitive)

• - Removedyallist@2.1.2(transitive)