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

@badger-commerce/api-client

v1.6.0

Published

TypeScript API client for Badger Commerce

Downloads

35

Readme

Badger Commerce Typescript API Client

The Badger Commerce Typescript API Client is a library that allows you to easily integrate with the headless commerce platform Badger Commerce using TypeScript. It uses the Fetch API and is generated with the openapi-typescript-codegen code generator. The API specification used is available at https://app.swaggerhub.com/apis-docs/Kedos-Consulting-Ltd/badger-commerce-api.

Installation

To use the Badger Commerce Typescript API Client in your project, you can install it from npm:

npm install --save badger-commerce-typescript-api-client

Usage

Before using the Badger Commerce Typescript API Client, you will need to obtain an API key from Badger Commerce. Once you have your API key, you can use it to create an instance of the client:

import { BadgerCommerceSDK } from 'badger-commerce-typescript-api-client';

const apiKey = 'your_api_key_here';
const client = new BadgerCommerceSDK(apiKey);

The client exposes methods for each endpoint defined in the API specification. For example, to retrieve a list of products, you can use the getProducts method:

const products = await client.getProducts();
console.log(products);

The response will be a JavaScript object representing the response from the Badger Commerce API.

If you need to pass parameters to an endpoint, you can pass them as an object to the method:

const params = { limit: 10 };
const products = await client.getProducts(params);
console.log(products);

You can find more information about the available methods and parameters in the API specification.

Contributing

If you find a bug or have a feature request, please create an issue. Pull requests are welcome!

License

The Badger Commerce Typescript API Client is released under the MIT License.