0.1.3-c • Published 5 years ago

@jessedp/nedb-async v0.1.3-c

Weekly downloads
6
License
MIT
Repository
github
Last release
5 years ago

Nedb-Async

nedb-async is a simply promise base wrapper methods for Nedb

Installation

Install with npm

  npm install nedb-async

or with yarn

  yarn add nedb-async

Usage

It is very simple and to avoid too much complexity all the cursor modifiers for find, findOne and count methods has to be pass as the last argument in an array.


Very important to know that all the promise base methods starts with async then the method name in camel casing

  • asyncFind
  • asyncFindOne
  • asyncCount
  • asyncInsert
  • asyncUpdate
  • asyncRemove
  • asyncEnsureIndex
  • asyncRemoveIndex

and every other ned`b origin methods are still available.

Usage:

db.asyncFind({}, [['sort', { name: -1 }], ['limit', 2]])
  .then(function(docs) {})
  .catch(function(error) {})
//Or with async await
async function getUsers() {
  let users = await db.asyncFind({}, [['limit', 100]])
}

async function countAllUsers() {
  let users = await db.asyncCount({})
}

For Nodejs

const DB = require('nedb-async')

const data = new Nedb({
  filename: 'data.db',
  autoload: true,
})

Typescript

For typescript users conceder using this approach for better types support

import Nedb from 'nedb-async'

interface IUser {
  firstName: string
  lastName: string
  age: number
  email: string
}

const User = new Nedb<IUser>({ filename: 'data.db', autoload: true })

Please use the official Nedb documentation for more information.

Licence

MIT