@hmcts/cmc-draft-store-middleware
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    @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

    Keywords

    none

    Install

    npm i @hmcts/cmc-draft-store-middleware

    DownloadsWeekly Downloads

    68

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    14.1 kB

    Total Files

    11

    Last publish

    Collaborators

    • adamsilver
    • adrianc
    • andrewwa-kainos
    • bendiggle
    • damdun
    • dharmendrak
    • ellie-harrison
    • hemantt
    • jenkins-reform-hmcts
    • p.jar
    • pragnesh
    • robertparkinson
    • sabah.irfan
    • timja
    • timja-hmcts
    • trevorsaint