scale-axios-client

This is a fork of ng-ui-api-client. It's a Typescript API client for Centersight scale API resources.

How to use this?

Install

# Install the client
npm i @deviceinsight/scale-axios-client

# You will need these peer dependencies if you're not using them yet
npm i axios@^0.26.0 ux4iot-admin-node@^3.1.0

Compatibility & Versioning

This client has been forked off of @device-insight/[email protected].

At the time of the fork, NG Platform 11.x was already available and the 10.x UI client seemed to work with it.

Thus, scale-axios-client should be compatible with NG Platform 11.x.

This project will not attempt to follow the NG versioning scheme. If the scale REST API changes or get additional features, this client will be updated along with these compatibility notes.

This project starts at 1.0.0 and will attempt to follow semantic versioning.

Usage

import {AxiosInstance} from 'axios';
import {ScaleApi} from './ScaleApi';

const axios: AxiosInstance = configureYourOwnAxiosInstance(); // !!!
const scaleApi = new ScaleApi(axios);

await scaleApi.assets.createAsset(/*...*/);

Differences to ng-ui-api-client

1. This one can be configured with a custom axios instance

Motivation

Initially we dropped ng-ui-api-client into our backend to profit from some of its type safety. It required us to register a global axios instance for the client to work.

This did no longer work once we wanted to use different authorization settings per request (e.g. authorize on behalf of the requesting user) as it expects one single global axios instance.