@flywire/flywire-js

flywire-js ·

Flywire JavaScript client.

Installation

Add the dependency to your package.json:

npm i @flywire/flywire-js

Usage

import Flywire from '@flywire/flywire-js';

const flywire = Flywire({ token: 'TOKEN' });
flywire.country.findAll();

Config

Key	Description
token	Client token provided by Flywire. Default = null
mock	Enable mock mode. Default = false

Mock mode

The mock mode returns fake data and does not query the API. It works in node and browser, but a service worker is needed in the last case:

npx msw init <PUBLIC_DIR>

Create a new release

To create a new release, make all the changes that you need and commit them, then execute:

npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]

For example:

npm version patch

This will bump the package.json version, build a new bundle, commit, push the changes tagging them to a new release and update the documentation.

Then create a PR and request the review from other project commiters. Once accepted and merged to master, execute npm publish from master branch.