Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bajankristof/nedb-promises
A dead-simple promise wrapper for nedb.
https://github.com/bajankristof/nedb-promises
callback cursor database nedb nedb-promises promise promise-wrapper
Last synced: 6 days ago
JSON representation
A dead-simple promise wrapper for nedb.
- Host: GitHub
- URL: https://github.com/bajankristof/nedb-promises
- Owner: bajankristof
- License: mit
- Created: 2017-05-31T06:04:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-25T00:30:24.000Z (5 months ago)
- Last Synced: 2024-10-29T15:29:30.619Z (3 months ago)
- Topics: callback, cursor, database, nedb, nedb-promises, promise, promise-wrapper
- Language: JavaScript
- Size: 480 KB
- Stars: 299
- Watchers: 6
- Forks: 45
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
A dead-simple promise wrapper for [nedb](https://github.com/louischatriot/nedb#readme).
Check out the [docs](https://github.com/bajankristof/nedb-promises/blob/master/docs.md).
##### IMPORTANT
**As of `nedb-promises` `5.0.0` [nedb](https://github.com/louischatriot/nedb#readme) package has been replaced with a fork of the original package, [@seald-io/nedb](https://github.com/seald/nedb) to solve some vulnerability issues originating from `nedb`!**
```js
const Datastore = require('nedb-promises')
let datastore = Datastore.create('/path/to/db.db')
// #1
datastore.find({ field: true })
.then(...)
.catch(...)
// #2
datastore.find({ field: true })
.exec(...)
.then(...)
.catch(...)
// #1 and #2 are equivalent
datastore.findOne({ field: true })
.then(...)
.catch(...)
datastore.insert({ doc: 'yourdoc' })
.then(...)
.catch(...)
// or in an async function
async function findSorted(page, perPage = 10) {
return await datastore.find(...)
.sort(...)
.limit(perPage)
.skip(page * perPage)
}
```
### Installation
```sh
npm install --save nedb-promises
```
### Usage
Everything works as the original module, with a couple of exceptions:
* There are no callbacks.
* `loadDatabase` has been renamed to [`load`](https://github.com/bajankristof/nedb-promises/blob/master/docs.md#Datastore+load).
* The cursor's `projection` method has been renamed to [`project`](https://github.com/bajankristof/nedb-promises/blob/master/docs.md#Cursor+project).
* You should call `Datastore.create(...)` instead of `new Datastore(...)`. This way you can access the original [nedb](https://github.com/louischatriot/nedb#readme) properties, such as `datastore.persistence`.
* As of v2.0.0 the module supports events 😎... Check out the [docs about events](https://github.com/bajankristof/nedb-promises/blob/master/docs.md#Datastore)!
Check out the [original docs](https://github.com/louischatriot/nedb#readme)!
#### load( )
You don't need to call this as the module will automatically detect if the datastore has been loaded or not upon calling any other method.
```js
const Datastore = require('nedb-promises')
let datastore = Datastore.create('/path/to/db.db')
datastore.load(...)
.then(...)
.catch(...)
```
#### find( [query], [projection] ), findOne( [query], [projection] ), count( [query] )
These methods will return a Cursor object that works the same way it did before except when you call "exec" it takes no arguments and returns a Promise.
The cool thing about this implementation of the Cursor is that it behaves like a Promise. Meaning that you can `await` it and you can call `.then()` on it.
```js
const Datastore = require('nedb-promises')
let datastore = Datastore.create('/path/to/db.db')
//outside Promise chain
datastore.find(...)
.then(...)
.catch(...)
//insinde Promise chain
datastore.insert(...)
.then(() => {
return datastore.find(...)
})
.then(
// use the retrieved documents
)
;(async () => {
await datastore.find(...).sort(...).limit()
})()
```
#### other( ... )
All the other methods will take the same arguments as they did before (except the callback) and will return a Promise.
Check out the [docs](https://github.com/bajankristof/nedb-promises/blob/master/docs.md).