Skip to content

Commit

Permalink
docs: update links "nodkz.github.io" -> "typegoose.github.io"
Browse files Browse the repository at this point in the history
because of the repository transfer the old links point to 404
  • Loading branch information
hasezoey committed Jul 13, 2024
1 parent 0ddafac commit dacd9a5
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 31 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Make sure you read [Mastering-Markdown](https://guides.github.com/features/maste

- NodeJS: 0.0.0
- mongodb-memory-server-*: 0.0.0 <!--"latest" is not a version-->
- mongodb(the binary version): 0.0.0 <!--Let this stay at "0", when assuming default, also see https://nodkz.github.io/mongodb-memory-server/docs/guides/mongodb-server-versions#mongodb-memory-server-core-version-table -->
- mongodb(the binary version): 0.0.0 <!--Let this stay at "0", when assuming default, also see https://typegoose.github.io/mongodb-memory-server/docs/guides/mongodb-server-versions#mongodb-memory-server-core-version-table -->
- mongodb(the js package): 0.0.0 <!--Not required when having "mongoose" set-->
- mongoose: 0.0.0 <!--Remove this if not used-->
- system: <!--One of: Windows, MacOS, Linux (with distro and distro version)-->
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/distribution-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ assignees: 'hasezoey'
<!--
Make sure you read [Mastering-Markdown](https://guides.github.com/features/mastering-markdown/)
List of currently [Supported Systems](https://nodkz.github.io/mongodb-memory-server/docs/guides/supported-systems)
List of currently [Supported Systems](https://typegoose.github.io/mongodb-memory-server/docs/guides/supported-systems)
-->

## Versions
Expand Down Expand Up @@ -72,7 +72,7 @@ console.log("Arch", os.arch());
## Current Error

<!--Please include the current error you are having, if any-->
<!--Also if you see any "Falling back to legacy MongoDB build!" please include Debug Output, see https://nodkz.github.io/mongodb-memory-server/docs/guides/enable-debug-mode -->
<!--Also if you see any "Falling back to legacy MongoDB build!" please include Debug Output, see https://typegoose.github.io/mongodb-memory-server/docs/guides/enable-debug-mode -->

```txt
Paste Error in Here
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This package spins up an actual/real MongoDB server programmatically from within

On install, this [package downloads](#configuring-which-mongod-binary-to-use) the latest MongoDB binaries and saves them to a cache folder. (only `mongodb-memory-server-core` does not download on `postinstall`)

On starting a new instance of the memory server, if the binary cannot be found, it will be auto-downloaded (if [`RUNTIME_DOWNLOAD`](https://nodkz.github.io/mongodb-memory-server/docs/api/config-options#runtime_download) option is truthy), thus the first run may take some time. All further runs will be fast, because they will use the downloaded binaries.
On starting a new instance of the memory server, if the binary cannot be found, it will be auto-downloaded (if [`RUNTIME_DOWNLOAD`](https://typegoose.github.io/mongodb-memory-server/docs/api/config-options#runtime_download) option is truthy), thus the first run may take some time. All further runs will be fast, because they will use the downloaded binaries.

This package automatically downloads binaries from [https://fastdl.mongodb.org/](https://fastdl.mongodb.org/) according to your operating system. You can see all available versions for [Linux](https://www.mongodb.org/dl/linux) (Ubuntu, RHEL, Debian, SUSE, Amazon), [OSX](https://www.mongodb.org/dl/osx), and [Windows](https://www.mongodb.org/dl/win32).

Expand Down Expand Up @@ -82,11 +82,11 @@ On Linux, you will also need `libcurl4` (or `libcurl3` on some older distro vers

### Choose the Correct Package

[Choose the right package for the task](https://nodkz.github.io/mongodb-memory-server/docs/guides/quick-start-guide#choose-the-right-package)
[Choose the right package for the task](https://typegoose.github.io/mongodb-memory-server/docs/guides/quick-start-guide#choose-the-right-package)

### Configuring which mongod binary to use

The default behavior is that version `6.0.14` for your OS will be downloaded. By setting [Environment variables](https://nodkz.github.io/mongodb-memory-server/docs/api/config-options) you are able to specify which version and binary will be downloaded:
The default behavior is that version `6.0.14` for your OS will be downloaded. By setting [Environment variables](https://typegoose.github.io/mongodb-memory-server/docs/api/config-options) you are able to specify which version and binary will be downloaded:

```sh
export MONGOMS_DOWNLOAD_URL=https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1804-4.2.8.tgz
Expand Down Expand Up @@ -129,7 +129,7 @@ const mongod = new MongoMemoryServer({
},
binary?: {
version?: string, // by default '6.0.14'
downloadDir?: string, // see the documentation on what is chosen by default https://nodkz.github.io/mongodb-memory-server/docs/api/config-options#download_dir
downloadDir?: string, // see the documentation on what is chosen by default https://typegoose.github.io/mongodb-memory-server/docs/api/config-options#download_dir
platform?: string, // by default os.platform()
arch?: string, // by default os.arch()
checkMD5?: boolean, // by default false OR process.env.MONGOMS_MD5_CHECK
Expand Down Expand Up @@ -217,7 +217,7 @@ const replSet = new MongoMemoryReplSet({

### Config Options

[Documentation of Config Options](https://nodkz.github.io/mongodb-memory-server/docs/api/config-options)
[Documentation of Config Options](https://typegoose.github.io/mongodb-memory-server/docs/api/config-options)

### Simple test with MongoClient in Jest

Expand Down Expand Up @@ -247,13 +247,13 @@ const mongoServer = await MongoMemoryServer.create();

### Test Runner Examples

[Documentation for Test Runner Integration Examples](https://nodkz.github.io/mongodb-memory-server/docs/guides/integration-examples/test-runners)
[Documentation for Test Runner Integration Examples](https://typegoose.github.io/mongodb-memory-server/docs/guides/integration-examples/test-runners)

### Docker Alpine

There isn't currently an official MongoDB release for alpine linux. This means that we can't pull binaries for Alpine
(or any other platform that isn't officially supported by MongoDB), but you can use a Docker image that already has mongod
built in and then set the [`MONGOMS_SYSTEM_BINARY`](https://nodkz.github.io/mongodb-memory-server/docs/api/config-options#system_binary) variable to point at that binary. This should allow you to use `mongodb-memory-server` on any system on which you can install mongod manually.
built in and then set the [`MONGOMS_SYSTEM_BINARY`](https://typegoose.github.io/mongodb-memory-server/docs/api/config-options#system_binary) variable to point at that binary. This should allow you to use `mongodb-memory-server` on any system on which you can install mongod manually.

### Enable Debug Mode

Expand All @@ -275,7 +275,7 @@ or
}
```

Also see the [Enable Debug Mode](https://nodkz.github.io/mongodb-memory-server/docs/guides/enable-debug-mode) Guide.
Also see the [Enable Debug Mode](https://typegoose.github.io/mongodb-memory-server/docs/guides/enable-debug-mode) Guide.

## Contributing

Expand All @@ -287,9 +287,9 @@ To ask questions or just talk with us, [join our Discord Server](https://discord

## Documentation

- [Documentation](https://nodkz.github.io/mongodb-memory-server/docs/api/index-api)
- [Quick start guide](https://nodkz.github.io/mongodb-memory-server/docs/guides/quick-start-guide/)
- [Known Issues](https://nodkz.github.io/mongodb-memory-server/docs/guides/known-issues)
- [Documentation](https://typegoose.github.io/mongodb-memory-server/docs/api/index-api)
- [Quick start guide](https://typegoose.github.io/mongodb-memory-server/docs/guides/quick-start-guide/)
- [Known Issues](https://typegoose.github.io/mongodb-memory-server/docs/guides/known-issues)

## Credits

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/error-warning-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Example:
```txt
Incorrect State for operation: "${gotState}", allowed States: "[${wantedStates.join(',')}]"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything
```

Details:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@ exports[`MongoMemoryReplSet getters & setters setter of "replSetOpts" should thr
exports[`MongoMemoryReplSet getters & setters state errors setter of "binaryOpts" should throw an error if state is not "stopped" 1`] = `
"Incorrect State for operation: \\"init\\", allowed States: \\"[stopped]\\"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
`;

exports[`MongoMemoryReplSet getters & setters state errors setter of "instanceOpts" should throw an error if state is not "stopped" 1`] = `
"Incorrect State for operation: \\"init\\", allowed States: \\"[stopped]\\"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
`;

exports[`MongoMemoryReplSet getters & setters state errors setter of "replSetOpts" should throw an error if state is not "stopped" 1`] = `
"Incorrect State for operation: \\"init\\", allowed States: \\"[stopped]\\"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
`;

exports[`MongoMemoryReplSet server version specific should warn if "ephemeralForTest" is used explicitly in mongodb 7.0 1`] = `
Expand All @@ -38,27 +38,27 @@ This warning is because the mentioned storage engine is explicitly used and mong
exports[`single server replset "_initReplSet" should throw an error if _state is not "init" 1`] = `
"Incorrect State for operation: \\"running\\", allowed States: \\"[init]\\"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
`;

exports[`single server replset "_initReplSet" should throw if server count is 0 or less 1`] = `"One or more servers are required."`;

exports[`single server replset "getUri" should throw an error if _state is not "running" or "init" 1`] = `
"Incorrect State for operation: \\"stopped\\", allowed States: \\"[running,init]\\"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
`;

exports[`single server replset "new" should throw an error if replSet count is 0 or less 1`] = `"ReplSet Count needs to be 1 or higher! (specified count: \\"0\\")"`;

exports[`single server replset "start" should throw an error if _state is not "stopped" 1`] = `
"Incorrect State for operation: \\"running\\", allowed States: \\"[stopped]\\"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
`;

exports[`single server replset "waitUntilRunning" should throw an error if _state is not "init" 1`] = `
"Incorrect State for operation: \\"stopped\\", allowed States: \\"[running,init]\\"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
`;
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ exports[`MongoMemoryServer "createAuth" should throw an error if called without
exports[`MongoMemoryServer cleanup() should not support boolean arguments 1`] = `
"Incorrect State for operation: \\"new\\", allowed States: \\"[stopped]\\"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
`;

exports[`MongoMemoryServer cleanup() should throw an error if state is not "stopped" 1`] = `
"Incorrect State for operation: \\"new\\", allowed States: \\"[stopped]\\"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
`;

exports[`MongoMemoryServer ensureInstance() should throw an error if "instanceInfo" is undefined but "_state" is "running" 1`] = `"\\"instanceInfo\\" was undefined when expected to be defined! (where: \\"MongoMemoryServer.ensureInstance (state: running)\\")"`;
Expand All @@ -21,7 +21,7 @@ exports[`MongoMemoryServer ensureInstance() should throw an error if no "instanc
exports[`MongoMemoryServer ensureInstance() should throw an error if the given "_state" has no case 1`] = `
"Incorrect State for operation: \\"not Existing\\", allowed States: \\"[running,new,stopped,starting]\\"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
`;

exports[`MongoMemoryServer getStartOptions() should work with -latest versions [#841] 1`] = `
Expand All @@ -35,13 +35,13 @@ Array [
exports[`MongoMemoryServer getUri() should throw an state error, if not starting or running 1`] = `
"Incorrect State for operation: \\"new\\", allowed States: \\"[running,starting]\\"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
`;

exports[`MongoMemoryServer getUri() should throw an state error, if not starting or running 2`] = `
"Incorrect State for operation: \\"new\\", allowed States: \\"[running,starting]\\"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
`;

exports[`MongoMemoryServer server version specific should warn if "ephemeralForTest" is used explicitly in mongodb 7.0 1`] = `
Expand All @@ -56,13 +56,13 @@ This warning is because the mentioned storage engine is explicitly used and mong
exports[`MongoMemoryServer start() should throw an error if state is not "new" or "stopped" 1`] = `
"Incorrect State for operation: \\"starting\\", allowed States: \\"[new,stopped]\\"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
`;

exports[`MongoMemoryServer start() should throw an error if state is not "new" or "stopped" 2`] = `
"Incorrect State for operation: \\"running\\", allowed States: \\"[new,stopped]\\"
This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:
https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything"
`;

exports[`MongoMemoryServer stop() should not support boolean arguments 1`] = `"Unsupported argument type: boolean"`;
2 changes: 1 addition & 1 deletion packages/mongodb-memory-server-core/src/util/errors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export class StateError extends Error {
','
)}]"\n` +
'This may be because of using a v6.x way of calling functions, look at the following guide if anything applies:\n' +
'https://nodkz.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything'
'https://typegoose.github.io/mongodb-memory-server/docs/guides/migration/migrate7#no-function-other-than-start-create-ensureinstance-will-be-starting-anything'
);
}
}
Expand Down
2 changes: 1 addition & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ module.exports = {
title: 'mongodb-memory-server',
tagline:
'Spinning up mongod in memory for fast tests. If you run tests in parallel this lib helps to spin up dedicated mongodb servers for every test file in MacOS, *nix, Windows or CI environments (in most cases with zero-config).',
url: 'https://nodkz.github.io',
url: 'https://typegoose.github.io',
baseUrl: baseUrl,
favicon: 'img/favicon.ico',
organizationName: 'nodkz',
Expand Down

0 comments on commit dacd9a5

Please sign in to comment.