Skip to content

Commit 527682d

Browse files
committed
docs: fix outdated and broken links
as reported by docusaurs v3
1 parent 105d014 commit 527682d

File tree

4 files changed

+18
-8
lines changed

4 files changed

+18
-8
lines changed

docs/api/classes/mongo-instance.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Typings: `constructor(opts: Partial<MongodOpts>)`
1414
Create an new Instance without starting it
1515

1616
:::tip
17-
When directly starting the instance, [`run`](#static-run) should be used
17+
When directly starting the instance, [`create`](#create) should be used
1818
:::
1919

2020
### debug
@@ -61,7 +61,7 @@ Will not Error if instance is not running
6161

6262
Typings: `_launchMongod(mongoBin: string): ChildProcess`
6363

64-
Actually spawn the `mongod` process with `ChildProcess`, used by [`run`](#run)
64+
Actually spawn the `mongod` process with `ChildProcess`, used by [`start`](#start)
6565

6666
### _launchKiller
6767

@@ -110,20 +110,28 @@ Matches process output against known formats and raise events
110110

111111
Typings: `instanceOpts: MongoInstanceOpts`
112112

113+
Also known as `instance` for [`new`](#new) & [`create`](#create).
114+
113115
Stores the Instance Options
114116

115117
### binaryOpts
116118

117119
Typings: `readonly binaryOpts: Readonly<MongoBinaryOpts>`
118120

121+
Also known as `binary` for [`new`](#new) & [`create`](#create).
122+
119123
Stores the Binary Options
120124

121125
### spawnOpts
122126

123127
Typings: `readonly spawnOpts: Readonly<SpawnOptions>`
124128

129+
Also known as `spawn` for [`new`](#new) & [`create`](#create).
130+
125131
Stores the Spawn Options
126132

133+
See NodeJS [`child_process.spawn` options](https://nodejs.org/api/child_process.html#child_processspawncommand-args-options) for details.
134+
127135
### extraConnectionOptions
128136

129137
<span class="badge badge--warning">Internal</span>

docs/api/classes/mongo-memory-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ It is still usefull if an user is always required in connection logic and mongod
132132

133133
Typings: `get instanceInfo(): MongoInstanceData | undefined`
134134

135-
Getter for [`_instanceInfo`](#_instanceInfo)
135+
Getter for [`_instanceInfo`](#_instanceinfo)
136136

137137
### _instanceInfo
138138

docs/api/interfaces/replset-opts.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,9 @@ Default: `{}`
6161

6262
Set extra spawn options to pass to `childProcess.spawn`.
6363

64-
Also see [`MongoMemoryInstanceOpts.spawn`](./mongo-memory-instance-opts.md#spawn).
64+
Also see [`MongoInstance`'s `spawn`](../classes/mongo-instance.md#spawnopts).
65+
66+
See NodeJS [`child_process.spawn` options](https://nodejs.org/api/child_process.html#child_processspawncommand-args-options) for details.
6567

6668
### storageEngine
6769

docs/guides/known-issues.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ It is known that ArchLinux on Docker does not have an `/etc/os-release` or `/etc
1010
Workaround:
1111

1212
- Create one of these files (either manually, or install `lsb-release`)
13-
- Use a SystemBinary with [`SYSTEM_BINARY`](../api/config-options.md#SYSTEM_BINARY)
14-
- Use an pre-set Archive Name to be used with [`ARCHIVE_NAME`](../api/config-options.md#ARCHIVE_NAME)
13+
- Use a SystemBinary with [`SYSTEM_BINARY`](../api/config-options.md#system_binary)
14+
- Use an pre-set Archive Name to be used with [`ARCHIVE_NAME`](../api/config-options.md#archive_name)
1515

1616
## No Build available for Alpine Linux
1717

18-
It is known that [AlpineLinux](./supported-systems.md#Alpine) does not have an official build (and no build like the ubuntu build works).
18+
It is known that [AlpineLinux](./supported-systems.md#alpine) does not have an official build (and no build like the ubuntu build works).
1919

2020
Workaround:
2121

22-
- Use a SystemBinary with [`SYSTEM_BINARY`](../api/config-options.md#SYSTEM_BINARY)
22+
- Use a SystemBinary with [`SYSTEM_BINARY`](../api/config-options.md#system_binary)
2323
- Do not use AlpineLinux
2424

2525
## libcurl on older or custom Docker images

0 commit comments

Comments
 (0)