Skip to content

Commit

Permalink
style(MongoInstance::ReplicaMemberConfig): change "defaultValue" to "…
Browse files Browse the repository at this point in the history
…default" in tsdoc
  • Loading branch information
hasezoey committed Jun 15, 2022
1 parent fb40d33 commit 7b0c98e
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions packages/mongodb-memory-server-core/src/util/MongoInstance.ts
Expand Up @@ -42,33 +42,33 @@ export type StorageEngine = 'devnull' | 'ephemeralForTest' | 'mmapv1' | 'wiredTi
export interface ReplicaMemberConfig {
/**
* A boolean that identifies an arbiter.
* @defaultValue `false` - A value of `true` indicates that the member is an arbiter.
* @default false - A value of `true` indicates that the member is an arbiter.
*/
arbiterOnly?: boolean;

/**
* A boolean that indicates whether the mongod builds indexes on this member.
* You can only set this value when adding a member to a replica set.
* @defaultValue `true`
* @default true
*/
buildIndexes?: boolean;

/**
* The replica set hides this instance and does not include the member in the output of `db.hello()` or `hello`.
* @defaultValue `true`
* @default true
*/
hidden?: boolean;

/**
* A number that indicates the relative eligibility of a member to become a primary.
* Specify higher values to make a member more eligible to become primary, and lower values to make the member less eligible.
* @defaultValue 1.0 for primary/secondary; 0 for arbiters.
* @default 1 for primary/secondary; 0 for arbiters.
*/
priority?: number;

/**
* A tags document contains user-defined tag field and value pairs for the replica set member.
* @defaultValue `null`
* @default null
* @example
* ```ts
* { "<tag1>": "<string1>", "<tag2>": "<string2>",... }
Expand All @@ -80,20 +80,20 @@ export interface ReplicaMemberConfig {
* Mongodb 4.x only - The number of seconds "behind" the primary that this replica set member should "lag".
* For mongodb 5.x, use `secondaryDelaySecs` instead.
* @see {@link https://docs.mongodb.com/v4.4/tutorial/configure-a-delayed-replica-set-member/}
* @defaultValue 0
* @default 0
*/
slaveDelay?: number;

/**
* Mongodb 5.x only - The number of seconds "behind" the primary that this replica set member should "lag".
* @defaultValue 0
* @default 0
*/
secondaryDelaySecs?: number;

/**
* The number of votes a server will cast in a replica set election.
* The number of votes each member has is either 1 or 0, and arbiters always have exactly 1 vote.
* @defaultValue 1
* @default 1
*/
votes?: number;
}
Expand Down

0 comments on commit 7b0c98e

Please sign in to comment.