@hmcts/cmc-draft-store-middleware
v2.0.1
Published
Node.js middleware for draft store
Downloads
50
Maintainers
Keywords
Readme
@hmcts/cmc-draft-store-middleware
This is a Node.js/Express library for interacting with the draft store API. The middleware retrieves draft of selected type from the draft store API and sets it in Express.js local user scope. If draft does not exist in the draft store then an empty draft is set it in Express.js local user scope.
Getting started
How to use it?
Installation
To add library to the project dependencies run:
$ yarn add @hmcts/cmc-draft-store-middleware
or
$ npm install @hmcts/cmc-draft-store-middleware
Sample code
Example use of the middleware in the Express.js application is presented below:
import { DraftMiddleware } from '@hmcts/cmc-draft-store-middleware'
const draftService: DraftService = ... // initiate draft service prior using middleware
app.all(/^.*$/, DraftMiddleware.requestHandler(draftService, 'default', (value: any): any => value))
How to contribute?
Prerequisites
Dependencies
Install dependencies by executing the following command:
$ yarn install
Code style
We use TSLint with StandardJS rules
Run the linting:
$ yarn lint
Linting will also run automatically prior to committing changes.
Running the tests
Mocha is used for writing tests.
Run them with:
$ yarn test
For test coverage run:
$ yarn test:coverage
License
This project is licensed under the MIT License - see the LICENSE file for details