JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 27
  • Score
    100M100P100Q47029F
  • License MIT

API client for the unofficial steam storefront/big picture resource

Package Exports

  • steam-store

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (steam-store) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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