sneakerdb-client
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

SneakerDB Client

Maintainability Test Coverage codecov Build on Main License Last Commit dependencies

Node.js client for interacting with the Sneaker Database API.

Installation

npm install sneakerdb-client

Usage

const { TheSneakerDatabaseClient } = require('sneakerdb-client');

// Create a client instance with your API key
const client = new TheSneakerDatabaseClient('your-api-key');

// Example: Get sneakers
client.getSneakers({ limit: 5 }).then(response => {
  console.log(response);
});

API

There are 4 methods available on the client instance:

  • getSneakers: gets a list of sneakers based on the provided options.
  • getSneakerById: gets a sneaker by its TheSneakerDatabase ID.
  • getBrands: Gets the list of brands
  • getGenders: get the list of genders
  • search: search for sneakers based on the provided options.

For more information on the available options, please refer to the API documentation.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Package Sidebar

Install

npm i sneakerdb-client

Weekly Downloads

1

Version

1.0.0

License

MIT

Unpacked Size

12.9 kB

Total Files

15

Last publish

Collaborators

  • angelxmoreno