EZFacilityClient

Install

npm install --save ezfacility-client

How to use

new EZFacilityClient()

import EZFacilityClient from 'ezfacility-client';
// or const EZFacilityClient = require('ezfacility-client').default;

API Reference

Read the whole API's documentation here: API Reference.

Contributing

Code style

We use JavaScript Standard Style as the guide for the code style. You can run npm run lint or npm run lint:fix to check (and fix) lint issues.

Also, lint:fix will be executed on Git's pre-commit hook.

Generation of documentation

Reference documentation is generated automatically by reading JSDoc from code files.

The command to do so is npm run docs:generate, and this command is executed before publishing the package to NPM.

Testing

Tests are strongly encouraged. Run them as often as you can. Even better, run npm run test:watch and do TDD.

Tests are also run before publishing the package to NPM.