@ifings/api-client

iFings API client

Usage no npm install needed!

<script type="module">
  import ifingsApiClient from 'https://cdn.skypack.dev/@ifings/api-client';
</script>

README

@ifings/api-client

Build and Publish standard-readme compliant make a pull request ifings-code-style Commitizen friendly

iFings API client

Table of Contents

About

This package provides a lightweight wrapper around the iFings API to allow for easy consumption on the frontend projects. It is currently being used by:

  • fng-web-hardware
  • fng-web-portal

Usage

import api from '@ifings/api-client'
api.licences.licenceLearnerCount(clientId).then(console.log).catch(console.error)

For more information, please see the Docs directory.

Install

This project uses node and npm.

$ npm install @ifings/api-client
$ # OR
$ yarn add @ifings/api-client

Publishing

This module uses the Automated releases for npm packages Github action for releasing when pushed to the master branch.

Versioning

  • If the string "BREAKING CHANGE" is found anywhere in any of the commit messages or descriptions the major version will be incremented.
  • If a commit message begins with the string "feat" then the minor version will be increased. This works for most common commit metadata for feature additions: "feat: new API" and "feature: new API".
  • All other changes will increment the patch version.

FAQS

Contribute

  1. Fork it and create your feature branch: git checkout -b my-new-feature
  2. Commit your changes: git commit -am "Add some feature"
  3. Push to the branch: git push origin my-new-feature
  4. Submit a pull request