@hmcts/cmc-draft-store-middleware

Node.js middleware for draft store

Stats

StarsIssuesVersionUpdatedCreatedSize
@hmcts/cmc-draft-store-middleware
2.0.12 years ago4 years agoMinified + gzip package size for @hmcts/cmc-draft-store-middleware in KB

Readme

@hmcts/cmc-draft-store-middleware

Travis badge Codecov badge NPM version badge Node version badge Greenkeeper badge Standard - JavaScript Style Guide

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

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.