json-server-reset

Reset middleware for json-server

Install

Requires Node version 8 or above (because of [email protected] peer dependency).

npm install --save json-server-reset

Use

reset

If you are using json-server, add this module as a middleware. For example, imagine our data file to be data.json with the following resources

{
  "todos": []
}

Then load the file and this middleware

json-server data.json --middlewares ./node_modules/json-server-reset

Then you can work with "todos" and reset the datastore (I am using httpie client in this examples)

$ http :3000/todos
[]
$ http POST :3000/todos text="do something"
{
    "id": 1,
    "text": "do something"
}
$ http POST :3000/todos text="do something else"
{
    "id": 2,
    "text": "do something else"
}
$ http :3000/todos
[
    {
        "id": 1,
        "text": "do something"
    },
    {
        "id": 2,
        "text": "do something else"
    }
]

Now reset the database back to the initial empty list of todos. Note := syntax to send the JSON as a list, not as a string.

$ http POST :3000/reset todos:=[]
$ http :3000/todos
[]

merge

Instead of overwriting the entire database with new data, you can merge the existing data with a subset (by the top key).

// current data
// { todos: [...], people: [...] }

Let's reset just the "people" resource list, leaving the todos unchanged. Include the src/merge.js middleware

json-server data.json --middlewares ./node_modules/json-server-reset --middlewares ./node_modules/json-server-reset/src/merge

Call the endpoint POST /merge

$ http POST :3000/merge people:=[]

// updated data
// { todos: [...], people: [] }

Init reset

If using this middleware from your server, you can clear some resources on startup

const initJsonServerReset = require('json-server-reset/src/init-reset')

const router = jsonServer.router(dataFilename)
// list of REST resources to clear on startup
const clear = ['todos']
server.use(initJsonServerReset({ db: router.db, clear }))

Debugging

Run this module with environment variable

DEBUG=json-server-reset

Using in your own server

If you want to use json-server-reset when building your own server that includes json-server, make sure the to initialize it by passing json-server reference and router database reference, and to add body-parser middleware before the reset. This middleware is included with json-server

Then set it to be the middleware before the rest of the json-server middlewares.

const jsonServer = require('json-server')
const reset = require('json-server-reset')

// create json server and its router first
const server = jsonServer.create()
const router = jsonServer.router(dataFilename)
server.use(
  jsonServer.defaults({
    static: '.', // optional static server folder
    bodyParser: true,
    readOnly: false,
  }),
)
server.use(reset)
server.db = router.db
server.use(router)

See example-server.js

Examples

• Cypress basics workshop
• Testing app example

Small print

Author: Gleb Bahmutov <[email protected]> © 2017

• @bahmutov
• glebbahmutov.com
• blog

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2017 Gleb Bahmutov <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.