Code Monkey home page Code Monkey logo

steam-store's Introduction

Steam Store

An API client for the unofficial Steam Storefront (Big Picture) resource, which provides methods to retrieve product information from the platform.

Latest: 0.4.0

Info

Features:

  • allows app listing, lookup and product search
  • usable with promises, stream and callbacks

Getting Started

var SteamStore = require('steam-store');

var store = new SteamStore({
  country:  'DE',
  language: 'en'
});

// store methods to call

Examples can be found here.

API

new SteamStore([options])

Available options for the store settings:

  • timeout - delay in ms to wait, in case the limit (~ 200 per 5 minutes) is reached | default: 5min
  • country - country code (US, GB, DE, ...) for the specific region, e.g. currency and exclusives | default: US
  • language - language of the descriptions

Custom

.getProducts([String|Array <String> types][, Booelan streamable][, Function callback])

.getProductsLists([Function callback])

.getProductsDetails(Array <String|Number> ids [, Boolean streamable][, Function callback])

.getProductsDetail(String|Number id [, Function callback])

.getProductLink(Number|String id)

Steam

.steam(String name [optional: arguments for the specific resource])

TODO

  • include package overview data
  • update documentation
  • write tests

steam-store's People

Contributors

autarc avatar kaplas avatar

Stargazers

xDeltaFox avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.