Skip to content

Commit

Permalink
Fix #75 add notice about commonJS issue
Browse files Browse the repository at this point in the history
  • Loading branch information
boly38 committed Apr 20, 2024
1 parent 9ba3185 commit acac9c1
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This readme contains some samples. Other samples are under [examples/](./example

You may notice that `mongodump` and `mongorestore` binaries are part of [database-tools](https://www.mongodb.com/docs/database-tools/installation/installation/) (follow standard installation for common OS). These binaries are mandatory for node-mongotools nodejs project as we are talking here of "wrapper" : a more convenient way to launch command + arguments from NodeJS code).

From a Github Actions context, you can install them via [action-mongo-tools](https://github.com/boly38/action-mongo-tools). There is an example in this project in [main workflow](.github/workflows/main.yml) that execute tests.
From a GitHub Actions context, you can install them via [action-mongo-tools](https://github.com/boly38/action-mongo-tools). There is an example in this project in [main workflow](.github/workflows/main.yml) that execute tests.


## Command line usage
Expand Down Expand Up @@ -120,6 +120,9 @@ const mtOptions = {
};
```

This project is compatible with ES Module projects that rely on `import`.
For now it's not compatible with CommonJS (`require`). But contribution are welcome.

### List dumps
```
var promiseResult = mongoTools.list(mtOptions);
Expand Down

0 comments on commit acac9c1

Please sign in to comment.