|
|
Welcome to the JSMumps wiki! |
|
|
## Installation
|
|
|
|
|
|
### With npm
|
|
|
|
|
|
`npm install jsmumps`
|
|
|
|
|
|
## Architecture
|
|
|
|
|
|
JSMumps will by default fork 10 child processes to handle database connections. This is necessary because NodeM does not yet support asynchronous database operations. Each database operation specified in your code will be handled by a free child process; if no child processes are available to service an operation, new child processes will be created as needed.
|
|
|
|
|
|
JSMumps redefines `process.exit()` in order to cleanly shut down child processes and close all open connections to NodeM.
|
|
|
|
|
|
## API Overview
|
|
|
|
|
|
### Instantiating JSMumps
|
|
|
|
|
|
The following example will create an instance of the JSMumps API using 30 child processes in the variable `jsm`, running at log level 4:
|
|
|
|
|
|
```javascript
|
|
|
const jsmumps = require('jsmumps');
|
|
|
|
|
|
var jsm = new jsmumps.JSMumps({
|
|
|
workerCount: 30,
|
|
|
logLevel: 4
|
|
|
});
|
|
|
```
|
|
|
|
|
|
From this point, you will be able to call JSMumps methods. |
|
|
\ No newline at end of file |