@redhat-cloud-services/host-inventory-client v1.4.3
Javascript client for Inventory API
If you want to use RedHatInsights/insights-host-inventory you shouldn't use get requests directly, but rather use this client to integrate with inventory service.
Install
NPM
npm install --save @redhat-cloud-services/host-inventory-client
Or Yarn
yarn add @redhat-cloud-services/host-inventory-client
Usage
This client is using typescript and axios. Types are distributed with this package, so no need to define or install them separately.
To correctly bootstrap this API you should use this config (no need to define it multiple times, just one config and reimport it anywhere you want to use it).
// api.js
import axios from 'axios';
import { HostsApi } from '@redhat-cloud-services/host-inventory-client';
const instance = axios.create();
// BASE_PATH should be set in your constants file
const hostsApi = new HostsApi(undefined, BASE_PATH, instance);
export hostsApi;
If you want to add some interceptors you can use axios build in interceptors
// api.js
import axios from 'axios';
import { HostsApi } from '@redhat-cloud-services/host-inventory-client';
const instance = axios.create();
// Request interceptor
instance.interceptors.request.use((request) => {
// some logic to do with request
});
// Response interceptor
instance.interceptors.response.use((response) => {
// some logic to do with request
});
// Error interceptor
instance.interceptors.response.use(null, (error) => {
// some logic to do with error
});
// BASE_PATH should be set in your constants file
const hostsApi = new HostsApi(undefined, BASE_PATH, instance);
export hostsApi;
Building
Run nx build @redhat-cloud-services/host-inventory-client
to build the library.
Running unit tests
Run nx test @redhat-cloud-services/host-inventory-client
to execute the unit tests via Jest.
API documentation
2 days ago
9 days ago
9 days ago
18 days ago
1 month ago
1 month ago
1 month ago
5 months ago
8 months ago
8 months ago
9 months ago
11 months ago
6 months ago
7 months ago
7 months ago
7 months ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years 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
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
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago