115 lines
3.4 KiB
TypeScript
115 lines
3.4 KiB
TypeScript
/** @public */
|
|
export type W = number | 'majority';
|
|
|
|
/** @public */
|
|
export interface WriteConcernOptions {
|
|
/** Write Concern as an object */
|
|
writeConcern?: WriteConcern | WriteConcernSettings;
|
|
}
|
|
|
|
/** @public */
|
|
export interface WriteConcernSettings {
|
|
/** The write concern */
|
|
w?: W;
|
|
/** The write concern timeout */
|
|
wtimeoutMS?: number;
|
|
/** The journal write concern */
|
|
journal?: boolean;
|
|
|
|
// legacy options
|
|
/** The journal write concern */
|
|
j?: boolean;
|
|
/** The write concern timeout */
|
|
wtimeout?: number;
|
|
/** The file sync write concern */
|
|
fsync?: boolean | 1;
|
|
}
|
|
|
|
export const WRITE_CONCERN_KEYS = ['w', 'wtimeout', 'j', 'journal', 'fsync'];
|
|
|
|
/**
|
|
* A MongoDB WriteConcern, which describes the level of acknowledgement
|
|
* requested from MongoDB for write operations.
|
|
* @public
|
|
*
|
|
* @see https://docs.mongodb.com/manual/reference/write-concern/
|
|
*/
|
|
export class WriteConcern {
|
|
/** request acknowledgment that the write operation has propagated to a specified number of mongod instances or to mongod instances with specified tags. */
|
|
w?: W;
|
|
/** specify a time limit to prevent write operations from blocking indefinitely */
|
|
wtimeout?: number;
|
|
/** request acknowledgment that the write operation has been written to the on-disk journal */
|
|
j?: boolean;
|
|
/** equivalent to the j option */
|
|
fsync?: boolean | 1;
|
|
|
|
/**
|
|
* Constructs a WriteConcern from the write concern properties.
|
|
* @param w - request acknowledgment that the write operation has propagated to a specified number of mongod instances or to mongod instances with specified tags.
|
|
* @param wtimeout - specify a time limit to prevent write operations from blocking indefinitely
|
|
* @param j - request acknowledgment that the write operation has been written to the on-disk journal
|
|
* @param fsync - equivalent to the j option
|
|
*/
|
|
constructor(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1) {
|
|
if (w != null) {
|
|
if (!Number.isNaN(Number(w))) {
|
|
this.w = Number(w);
|
|
} else {
|
|
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. */
|
|
static fromOptions(
|
|
options?: WriteConcernOptions | WriteConcern | W,
|
|
inherit?: WriteConcernOptions | WriteConcern
|
|
): WriteConcern | undefined {
|
|
if (options == null) return undefined;
|
|
inherit = inherit ?? {};
|
|
let opts: WriteConcernSettings | WriteConcern | undefined;
|
|
if (typeof options === 'string' || typeof options === 'number') {
|
|
opts = { w: options };
|
|
} else if (options instanceof WriteConcern) {
|
|
opts = options;
|
|
} else {
|
|
opts = options.writeConcern;
|
|
}
|
|
const parentOpts: WriteConcern | WriteConcernSettings | undefined =
|
|
inherit instanceof WriteConcern ? inherit : inherit.writeConcern;
|
|
|
|
const {
|
|
w = undefined,
|
|
wtimeout = undefined,
|
|
j = undefined,
|
|
fsync = undefined,
|
|
journal = undefined,
|
|
wtimeoutMS = undefined
|
|
} = {
|
|
...parentOpts,
|
|
...opts
|
|
};
|
|
if (
|
|
w != null ||
|
|
wtimeout != null ||
|
|
wtimeoutMS != null ||
|
|
j != null ||
|
|
journal != null ||
|
|
fsync != null
|
|
) {
|
|
return new WriteConcern(w, wtimeout ?? wtimeoutMS, j ?? journal, fsync);
|
|
}
|
|
return undefined;
|
|
}
|
|
}
|