write_concern.js
2.81 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
'use strict';
const kWriteConcernKeys = new Set(['w', 'wtimeout', 'j', 'journal', 'fsync']);
let utils;
/**
* The **WriteConcern** class is a class that represents a MongoDB WriteConcern.
* @class
* @property {(number|string)} w The write concern
* @property {number} wtimeout The write concern timeout
* @property {boolean} j The journal write concern
* @property {boolean} fsync The file sync write concern
* @see https://docs.mongodb.com/manual/reference/write-concern/index.html
*/
class WriteConcern {
/**
* Constructs a WriteConcern from the write concern properties.
* @param {(number|string)} [w] The write concern
* @param {number} [wtimeout] The write concern timeout
* @param {boolean} [j] The journal write concern
* @param {boolean} [fsync] The file sync write concern
*/
constructor(w, wtimeout, j, fsync) {
if (w != null) {
this.w = w;
}
if (wtimeout != null) {
this.wtimeout = wtimeout;
}
if (j != null) {
this.j = j;
}
if (fsync != null) {
this.fsync = fsync;
}
}
/**
* Construct a WriteConcern given an options object.
*
* @param {object} [options] The options object from which to extract the write concern.
* @param {(number|string)} [options.w] **Deprecated** Use `options.writeConcern` instead
* @param {number} [options.wtimeout] **Deprecated** Use `options.writeConcern` instead
* @param {boolean} [options.j] **Deprecated** Use `options.writeConcern` instead
* @param {boolean} [options.fsync] **Deprecated** Use `options.writeConcern` instead
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
* @return {WriteConcern}
*/
static fromOptions(options) {
if (
options == null ||
(options.writeConcern == null &&
options.w == null &&
options.wtimeout == null &&
options.j == null &&
options.journal == null &&
options.fsync == null)
) {
return;
}
if (options.writeConcern) {
if (typeof options.writeConcern === 'string') {
return new WriteConcern(options.writeConcern);
}
if (!Object.keys(options.writeConcern).some(key => kWriteConcernKeys.has(key))) {
return;
}
return new WriteConcern(
options.writeConcern.w,
options.writeConcern.wtimeout,
options.writeConcern.j || options.writeConcern.journal,
options.writeConcern.fsync
);
}
// this is down here to prevent circular dependency
if (!utils) utils = require('./utils');
utils.emitWarningOnce(
`Top-level use of w, wtimeout, j, and fsync is deprecated. Use writeConcern instead.`
);
return new WriteConcern(
options.w,
options.wtimeout,
options.j || options.journal,
options.fsync
);
}
}
module.exports = WriteConcern;