Description

An SDK Wrapper to use EdgeIQ API We will be using:

• Typescript
• Axios
• Jest
• Prettier

Requirements

• Node

Initial Setup

Just install the packages needed

$ npm install

Available Commands

• Building:

$ npm run build

• Linting:

$ npm run lint

• Formatting:

$ npm run format

• Testing

$ npm test

• Testing single test file

$ npm test src/__tests__/<file_name>

• To test the version locally before publishing: . In the edgeiq-api-js local copy run yarn link . In the project local copy, where it is needed to install this version (eiq30 fro example), run yarn link @edgeiq/edgeiq-api-js . This will “connect” the two repositories (via a symlink), so node_modules/@edgeiq/edgeiq-api-js actually points to your local copy. . You can then run yarn build in edgeiq-api-js and eiq30 will pick up the changes you did locally, so no need to publish a new SDK to test something . These commadns will change the yarn.lock and package.json of the project where the sdk is being used eiq30, to revert that run yarn unlink @edgeiq/edgeiq-api-js

Publishing:

Run:

$ npm publish

How to use it

• Install the dependency via the command line. npm install --save @edgeiq/edgeiq-api-js

  OR

  yarn add @edgeiq/edgeiq-api-js

This will install the latest version in npm