README

Payoff Request Library

The payoff request library is an NPM library for payoff request objects and functions written in Typescript.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Installing

To install this library's dependencies for development (i.e. modifying it):

$ cd payoff-request
$ npm i

Running the tests

The payoff request library uses the Jest framework for it's unit tests.

To run the tests in coverage mode:

$ npm run test

NOTE: You can view the HTML version of the coverage result by browsing locally into the

To run the tests in watch mode:

$ npm run test:watch

$ npm run test:watchAll

To run tests and view the HTML coverage report:

$ npm run test:view

Deployment

To publish the library to the NPM private repo, do the following:

$ cd payoff-request
$ npm login
$ npm publish

Usage

This library is installed as a private NPM library on a node.js project:

$ npm login
$ npm i @vikingsasquatch/payoff-request

Built With

Typescript - Typed superset of JavaScript used
NPM - JavaScript package/dependency management
NodeJS - Javascript runtime used
nvm - Node JS version management
Jest - JavaScript testing framework

Contributing

Please read the Viking Sasquatch development-standards for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Ken Taylor - Initial work - ktaylor

See also the list of contributors who participated in this project.

License

Acknowledgments

Hat tip to anyone whose code was used
Inspiration
etc

Usage no npm install needed!