FluidPay Node.js API

Provides a Node.js API for working with FluidPay's HTTP API

Head's Up This is very much a work in progress and incomplete. The API and types are also very subject to change. Use at your own risk!

Installation

npm install @mywell/fluidpay

or

yarn add @mywell/fluidpay

Local Development

Below is a list of commands you will probably find useful.

npm start or yarn start

Runs the project in development/watch mode. Your project will be rebuilt upon changes. TSDX has a special logger for you convenience. Error messages are pretty printed and formatted for compatibility VS Code's Problems tab.

Your library will be rebuilt if you make edits.

npm run build or yarn build

Bundles the package to the dist folder. The package is optimized and bundled with Rollup into multiple formats (CommonJS, UMD, and ES Module).

npm test or yarn test

Runs the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.

Publishing to NPM

This project is published automatically via GitHub Action when:

1. The version number changes and
2. There's a push on the main branch