lowdb-middleware

1.0.0 • Public • Published

LowDB Middleware

Forked version of JSON Server. This package is intended to used as middleware from within an ExpressJS application.

Roadmap

  • Update packages to latest versions
  • Drop CLI support
  • Rewrite code base to use ES6 style code ie: import fs from 'fs
  • Add API hooks
  • Basic Auth plugin
  • Database management endpoints
  • Add dynamic databases routes
  • Use FileAsync via async/await
  • Configurable setup
  • Snapshots / Restore

Fixes / Enhancements

The following PRs were implemented from json-server repository

  • Fix bug with null expand reference. PR640
  • Add _contains operation PR691
  • Add _attr option to reduce query context PR558
  • Add _flatten option to flatten nested objects
  • Add _keys option to reduce returned results

Example usage

Legacy database setup app.use('/test', middleware.staticRouter("./databases/test.json"))

New dynamic database setup app.use('/api', middleware.dynamicRouter())

structure is /api/{databasename}/{collection} => /api/application/users

Database management

List dynamic databases GET /api/db

Create new databases POST /api/db

Modify existing database PATCH /api/db

Documenation coming....

Package Sidebar

Install

npm i lowdb-middleware

Weekly Downloads

9

Version

1.0.0

License

MIT

Unpacked Size

51.7 kB

Total Files

37

Last publish

Collaborators

  • mgambill