https://github.com/bahmutov/json-server-reset
Reset middleware for json-server
https://github.com/bahmutov/json-server-reset
json-server json-server-middlewares reset
Last synced: 9 months ago
JSON representation
Reset middleware for json-server
- Host: GitHub
- URL: https://github.com/bahmutov/json-server-reset
- Owner: bahmutov
- Created: 2017-12-06T14:50:43.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-28T06:07:48.000Z (over 1 year ago)
- Last Synced: 2024-10-03T14:13:53.495Z (over 1 year ago)
- Topics: json-server, json-server-middlewares, reset
- Language: JavaScript
- Homepage:
- Size: 828 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# json-server-reset  
> Reset middleware for json-server
[![NPM][npm-icon] ][npm-url]
[![Build status][ci-image] ][ci-url]
[![semantic-release][semantic-image] ][semantic-url]
[![js-standard-style][standard-image]][standard-url]
[](https://cypress.io)
[![renovate-app badge][renovate-badge]][renovate-app]
## Install
Requires [Node](https://nodejs.org/en/) version 8 or above (because of `json-server@0.15` peer dependency).
```sh
npm install --save json-server-reset
```
## Use
### reset
If you are using [json-server](https://github.com/typicode/json-server), add this module as a middleware. For example, imagine our data file to be `data.json` with the following resources
```json
{
"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](https://httpie.org/) 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](./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
```js
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.
```js
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](./cypress/fixtures/example-server.js)
## Examples
- [Cypress basics workshop](https://github.com/bahmutov/cypress-workshop-basics)
- [Testing app example](https://github.com/bahmutov/testing-app-example)
### Small print
Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2017
- [@bahmutov](https://twitter.com/bahmutov)
- [glebbahmutov.com](https://glebbahmutov.com)
- [blog](https://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](https://github.com/bahmutov/json-server-reset/issues) on Github
## MIT License
Copyright (c) 2017 Gleb Bahmutov <gleb.bahmutov@gmail.com>
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.
[npm-icon]: https://nodei.co/npm/json-server-reset.svg?downloads=true
[npm-url]: https://npmjs.org/package/json-server-reset
[ci-image]: https://github.com/bahmutov/json-server-reset/actions/workflows/ci.yml/badge.svg?branch=master
[ci-url]: https://github.com/bahmutov/json-server-reset/actions/workflows/ci.yml
[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-url]: https://github.com/semantic-release/semantic-release
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[standard-url]: http://standardjs.com/
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/