docs: replace admonition ":::caution" with ":::warning"

as ":::caution" has been deprecated and replaced with ":::warning" in docusaurus 3.0, see: https://docusaurus.io/docs/migration/v3#admonition-warning
2026-09-24 17:00:24 +00:00 · 2025-04-22 14:09:22 +02:00
parent cf44f7f76c
commit 50ed31ff0e
10 changed files with 21 additions and 21 deletions
@@ -41,7 +41,7 @@ Typings: `async start(): Promise<void>`

 Start the `mongod` and the watcher processes

-:::caution
+:::warning
 Currently does not check if the instance is in a correct state and just resets all values, see [#662](https://github.com/typegoose/mongodb-memory-server/issues/662).
 :::

@@ -51,7 +51,7 @@ Typings: `async stop(): Promise<boolean>`

 Stop the `mongod` and the watcher processes

-:::caution
+:::warning
 Will not Error if instance is not running
 :::

@@ -55,7 +55,7 @@ Typings: `async start(): Promise<void>`

 Used to start an new ReplSet or to Re-Start an stopped ReplSet

-:::caution
+:::warning
 Will Error if ReplSet is already running
 :::

@@ -83,7 +83,7 @@ Stop an running instance, this function will by default call [`.cleanup`](#clean

 With `cleanupOptions` options for cleanup can be manually set.

-:::caution
+:::warning
 Will not Error if instance is not running
 :::

@@ -105,10 +105,10 @@ It is recommended to `await` the promise returned from `start` when available.

 Does not start the replset instance if not already starting (unlike [`ensureInstance`](./mongo-memory-server.md#ensureinstance)).

-:::caution
+:::warning
 Will Error if state is not `running` or `init`.
 :::
-:::caution
+:::warning
 Will **not** Error if a error is encountered while waiting.
 :::

@@ -154,7 +154,7 @@ Typings:

 Getter & Setter for [`_instanceOpts`](#_instanceopts)

-:::caution
+:::warning
 Will Throw an Error if `state` is not `stopped`
 :::

@@ -175,7 +175,7 @@ Typings:

 Getter & Setter for [`_binaryOpts`](#_binaryopts)

-:::caution
+:::warning
 Will Throw an Error if `state` is not `stopped`
 :::

@@ -196,7 +196,7 @@ Typings:

 Getter & Setter for [`_replSetOpts`](#_replsetopts)

-:::caution
+:::warning
 Will Throw an Error if `state` is not `stopped`
 :::

@@ -222,7 +222,7 @@ Typings: `get state(): MongoMemoryReplSetStates`

 Getter for [`_state`](#_state)

-:::caution
+:::warning
 Will Throw an Error if `state` is not `stopped`
 :::

@@ -40,7 +40,7 @@ Used to start an new Instance or to Re-Start an stopped instance
 with `forceSamePort` set to `true` and having `instance.port` set, it will use that port and not generate a new port.  
 with `forceSamePort` set to `true` and not having `instance.port` set, it will generate a new free port.  

-:::caution
+:::warning
 Will Error if instance is already running
 :::

@@ -79,7 +79,7 @@ Stop an running instance, this function will by default call [`.cleanup`](#clean

 With `cleanupOptions` options for cleanup can be manually set.

-:::caution
+:::warning
 Will not Error if instance is not running
 :::

@@ -99,7 +99,7 @@ Ensure that the instance is running, will run [`start`](#start) if stopped, will

 It is recommended to `await` the promise returned from `start` when available.

-:::caution
+:::warning
 Will Error if instance cannot be started
 :::

@@ -7,14 +7,14 @@ This Guide will show how `mongodb-memory-server` can be used with Docker & docke

 ## Important Notes before Starting

-:::caution
+:::warning
 It is common that images like `node:16-alpine` are used, which will not work with this package, because mongodb does not provide binaries for Alpine yet.
 It is recommended to switch to images like `node:16` (or `node:16-buster`) for Debian builds.

 See [No Build available for Alpine Linux](../known-issues.md#no-build-available-for-alpine-linux).
 :::

-:::caution
+:::warning
 Docker Debian builds (at least with `debian:11`), extra packages have to be installed:

 ```sh
@@ -94,7 +94,7 @@ afterAll(async () => {
 });
 ```

-:::caution
+:::warning
 It is very important to limit the spawned number of Jest workers on machines that have many cores, because otherwise the tests may run slower than with fewer workers, because the database instance(s) may be hit very hard.  
 Use either [`--maxWorkers 4`](https://jestjs.io/docs/configuration#maxworkers-number--string) or [`--runInBand`](https://jestjs.io/docs/cli#--runinband) to limit the workers.
 :::
@@ -5,7 +5,7 @@ title: 'Migrate to version 10.0.0'

 Here are the Important changes made for 10.0.0

-:::caution Important, Read this first
+:::warning Important, Read this first
 This Guide is written for migration from version `9.4.1` to `10.0.0`, for versions `>10.0.0 <11.0.0`, please consult the [CHANGELOG](https://github.com/typegoose/mongodb-memory-server/blob/master/CHANGELOG.md)
 :::

@@ -5,7 +5,7 @@ title: 'Migrate to version 7.0.0'

 Here are the Important changes made for 7.0.0

-:::caution Important, Read this first
+:::warning Important, Read this first
 This Guide is written for migration from version `6.9.6` to `7.0.0`, for versions `>7.0.0 <8.0.0`, please consult the [CHANGELOG](https://github.com/typegoose/mongodb-memory-server/blob/master/CHANGELOG.md)
 :::

@@ -5,7 +5,7 @@ title: 'Migrate to version 8.0.0'

 Here are the Important changes made for 8.0.0

-:::caution Important, Read this first
+:::warning Important, Read this first
 This Guide is written for migration from version `7.6.0` to `8.0.0`, for versions `>8.0.0 <9.0.0`, please consult the [CHANGELOG](https://github.com/typegoose/mongodb-memory-server/blob/master/CHANGELOG.md)
 :::

@@ -5,7 +5,7 @@ title: 'Migrate to version 9.0.0'

 Here are the Important changes made for 9.0.0

-:::caution Important, Read this first
+:::warning Important, Read this first
 This Guide is written for migration from version `8.16.0` to `9.0.0`, for versions `>9.0.0 <10.0.0`, please consult the [CHANGELOG](https://github.com/typegoose/mongodb-memory-server/blob/master/CHANGELOG.md)
 :::

@@ -24,7 +24,7 @@ Heads up! Here's a pro-tip.
 Useful information.
 :::

-:::caution
+:::warning
 Warning! You better pay attention!
 :::