@micoach/js-sdk v0.4.8
@micoach/js-sdk
This is a Javascript client that utilizes Axios to interact with micoach API. This SDK can be used in the following environments:
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript projects. In TypeScript, the definition should be automatically resolved via package.json
as types are already included. (Reference)
How to install
First, install the SDK in the desired project:
npm install --save @micoach/js-sdk
Usage
Instantiate a client depending on the API you need, for example to consume the Candidates API:
import micoach from "@micoach/js-sdk";
const candidatesApi = new micoach.CandidatesApi({
accessToken: getAuthToken(), // this can be an async function
});
const response = await candidatesApi.listCandidates();
const candidates = response.data;
Override endpoint
By default, the SDK is pointing to the production environment, but you can easily override the environment by specifying the basePath property while instantiating a client:
import micoach from "@micoach/js-sdk";
const candidatesApi = new micoach.CandidatesApi({
basePath: "http://localhost:4000/api/micoach",
});
How to publish a new version
Go to the Generate SDK GitHub Action and click the Run workflow button.
Type the type of release: patch, minor or major.
Click run.
A new pull request will automatically be created. Review the changes and if everything looks good, merge the CR.
Create a new GitHub release and publish it.
4 months ago
4 months ago
7 months ago
7 months ago
7 months ago
8 months ago
8 months ago
7 months ago
8 months ago
9 months ago
8 months ago
8 months ago
9 months ago
9 months ago
9 months ago
11 months ago
11 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago