npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@redhat-cloud-services/host-inventory-client

v3.0.2

Published

If you want to use [RedHatInsights/host-inventory](https://github.com/RedHatInsights/host-inventory) you shouldn't use get requests directly, but rather use this client to integrate with this service.

Downloads

1,322

Readme

Javascript client for the host-inventory API

If you want to use RedHatInsights/host-inventory you shouldn't use get requests directly, but rather use this client to integrate with this 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.

This package comes with a client in its api.ts already defined with every call available.

`import host-inventoryClient from '@redhat-cloud-services/javascript-clients-shared/utils';

host-inventoryClient.someEndpoint();

To bootstrap this API manually, you should create your own client via the APIFactory defined in the @redhat-cloud-services/javascript-clients-shared package. See below for an example:

import APIFactory from '@redhat-cloud-services/javascript-clients-shared/utils'; 
import exampleEndpoint from '@redhat-cloud-services/host-inventory-client/ExampleEndpoint';

// BASE_PATH should be set in your constants file
const hostInventoryApi = APIFactory(BASE_PATH, undefined, { exampleEndpoint });
export hostInventoryApi;

If you want to add some interceptors you can use axios build in interceptors

import axios from 'axios';
import APIFactory from '@redhat-cloud-services/javascript-clients-shared/utils';
import exampleEndpoint from '@redhat-cloud-services/host-inventory-client/ExampleEndpoint';

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 hostInventoryApi = APIFactory(BASE_PATH, instance, { exampleEndpoint });
export hostInventoryApi;

Generating

Ensure you have the javascript-clients generator built first with npm run build:generator. Then, run nx run @redhat-cloud-services/host-inventory-client:generate to generate the package.

Building

Run nx run @redhat-cloud-services/host-inventory-client:build to build the package. This creates the dist for publishing.

Running unit tests

Run nx run @redhat-cloud-services/host-inventory-client:test to execute the unit tests via Jest.

API documentation