https://github.com/fortunejs/fortune-nedb

NeDB adapter for Fortune.
https://github.com/fortunejs/fortune-nedb

Last synced: about 2 months ago
JSON representation

NeDB adapter for Fortune.

• Host: GitHub
• URL: https://github.com/fortunejs/fortune-nedb
• Owner: fortunejs
• License: mit
• Created: 2015-08-15T13:03:50.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-09-14T06:59:11.000Z (over 7 years ago)
• Last Synced: 2024-04-26T23:03:26.057Z (9 months ago)
• Language: JavaScript
• Size: 31.3 KB
• Stars: 10
• Watchers: 2
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fortune NeDB Adapter

[![Build Status](https://img.shields.io/travis/fortunejs/fortune-nedb/master.svg?style=flat-square)](https://travis-ci.org/fortunejs/fortune-nedb)

[![npm Version](https://img.shields.io/npm/v/fortune-nedb.svg?style=flat-square)](https://www.npmjs.com/package/fortune-nedb)

[![License](https://img.shields.io/npm/l/fortune-nedb.svg?style=flat-square)](https://raw.githubusercontent.com/fortunejs/fortune-nedb/master/LICENSE)

This is a [NeDB](https://github.com/louischatriot/nedb) adapter for [Fortune](http://fortunejs.com).

## Usage

Install the `fortune-nedb` package from `npm`:

```

$ npm install fortune-nedb

```

Then use it with Fortune:

```js

const fortune = require('fortune')

const nedbAdapter = require('fortune-nedb')

const store = fortune({ ... }, {

  adapter: [ nedbAdapter, {/* options */} ]

})

```

## Options

All of the options are enumerated [here](https://github.com/louischatriot/nedb). Here are additional adapter-specific options:

- `dbPath`: Path to a directory where the database is persisted to disk. Optional.

Note that the `filename` option has no effect, since Fortune.js determines filenames based on type name.

In addition to the constructor options, there is also the `query` function in the `find` method, which accepts the query object as an argument, and may either mutate or return the query object. This allows for arbitrary queries.

## License

This software is licensed under the [MIT License](//github.com/fortunejs/fortune-nedb/blob/master/LICENSE).