The nintendo-switch-eshop from ibm9100

About

nintendo-switch-eshop is a npm lib module written to extract Nintendo Switch's eShop game and pricing information.

Installation

To install it just type the following at your command line

npm install --save nintendo-switch-eshop

And require it in your node module as follows:

const SwitchEshop = require('nintendo-switch-eshop');

Functions

getGamesAmerica([options]) ⇒ Promise<Array<GameUS>>: Fetches all games on american eshops. Paginates every 200 games.
getGamesJapan() ⇒ Promise<Array<GameJP>>: Fetches all games on japanese eshop.
getGamesEurope([options]) ⇒ Promise<Array<GameEU>>: Fetches all games on european eshop. Paginates every 9999 games.
getShopsByCountryCodes(countryCodes, gamecode, region) ⇒ Promise<Array<Eshop>>: Gets all active eshops given a list of countries.
getShopsAmerica() ⇒ Promise<Array<Eshop>>: Gets all active eshops on american countries. This method will launch several requests at nintendo web services, so don't abuse it.
getShopsEurope() ⇒ Promise<Array<Eshop>>: Gets all active eshops on european countries. Please note that South Africa and Oceania countries are included. This method will launch several requests at nintendo web services, so don't abuse it.
getShopsAsia() ⇒ Promise<Array<Eshop>>: Gets all active eshops on asian countries. This method will launch several requests at nintendo web services, so don't abuse it.
getActiveShops() ⇒ Promise<Array<Eshop>>: Gets all active eshops. This method will launch several requests at nintendo web services, so don't abuse it.
getPrices(country, gameIds) ⇒ Promise<PriceResponse>: Get pricing information for the requested games. Paginates every 50 games.
parseGameCode(game, region) ⇒ string: Parses the game code to extract the cross-region protion.
parseNSUID(game, region) ⇒ string: Extracts NSUID information from the game object.

Typedefs

Categories : Object
GameUS : Object
GameEU : Object
GameJP : Object
EShop : Object
PriceResponse : Object
TitleData : Object
PriceError : Object
PriceData : Object
RequestOptions : Object

Region : `enum`

Region code constant.

Kind: global enum
Read only: true
Properties

Name	Type	Default
AMERICAS	`number`	`1`
EUROPE	`number`	`2`
ASIA	`number`	`3`

getGamesAmerica([options]) ⇒ `Promise.<Array.<GameUS>>`

Fetches all games on american eshops. Paginates every 200 games.

Kind: global function
Returns: Promise.<Array.<GameUS>> - Promise containing all the games.

Param	Type	Description
[options]	`RequestOptions`	Request options (Optional)

getGamesJapan() ⇒ `Promise.<Array.<GameJP>>`

Fetches all games on japanese eshop.

Kind: global function
Returns: Promise.<Array.<GameJP>> - Promise containing all the games.

getGamesEurope([options]) ⇒ `Promise.<Array.<GameEU>>`

Fetches all games on european eshop. Paginates every 9999 games.

Kind: global function
Returns: Promise.<Array.<GameEU>> - Promise containing all the games.

Param	Type	Description
[options]	`RequestOptions`	Request options (Optional)

getShopsByCountryCodes(countryCodes, gamecode, region) ⇒ `Promise<Array<Eshop>>`

Gets all active eshops given a list of countries.

Kind: global function
Returns: Promise<Array<Eshop>> - A list of shop objects with country code, name and default currency.

Param	Type	Description
countryCodes	`Array<string>`	A list of 2 digit country codes for every country eshop to lookup. (ISO 3166-1 alpha-2 country codes)
gamecode	`string`	A 14 digits game NSUID from the desired region.
region	`number`	A region id that will be appendend in the final shop object for filtering purposes.

getShopsAmerica() ⇒ `Promise<Array<Eshop>>`

Gets all active eshops on american countries. This method will launch several requests at nintendo web services, so don't abuse it.

Kind: global function
Returns: Promise<Array<Eshop>> - A list of shop objects with country code, name and default currency.

getShopsEurope() ⇒ `Promise<Array<Eshop>>`

Gets all active eshops on european countries. Please note that South Africa and Oceania countries are included. This method will launch several requests at nintendo web services, so don't abuse it.

Kind: global function
Returns: Promise<Array<Eshop>> - A list of shop objects with country code, name and default currency.

getShopsAsia() ⇒ `Promise<Array<Eshop>>`

Gets all active eshops on asian countries. This method will launch several requests at nintendo web services, so don't abuse it.

Kind: global function
Returns: Promise<Array<Eshop>> - A list of shop objects with country code, name and default currency.

getActiveShops() ⇒ `Promise<Array<Eshop>>`

Gets all active eshops. This method will launch several requests at nintendo web services, so don't abuse it.

Kind: global function
Returns: Promise<Array<Eshop>> - A list of shop objects with country code, name and default currency.

getPrices(country, gameIds) ⇒ `Promise<PriceResponse>`

Get pricing information for the requested games. Paginates every 50 games.

Kind: global function
Returns: Promise<PriceResponse> - A promise containing the pricing information.

Param	Type	Description
country	`string`	A two digit country code. (ISO 3166-1 alpha-2 country code)
gameIds	`Array<string>` \| `string`	One or more NSUID of the corresponding games.

parseGameCode(game, region) ⇒ `string`

Parses the game code to extract the cross-region protion.

Kind: global function
Returns: string - The 4-digit resulting game code.

Param	Type	Description
game	`GameUS` \| `GameEU` \| `GameJP`	The game object returned from one of the other methods.
region	`number`	Region code. (use the Region constant)

parseNSUID(game, region) ⇒ `string`

Extracts NSUID information from the game object.

Kind: global function
Returns: string - The 14-digit NSUID.

Param	Type	Description
game	`GameUS` \| `GameEU` \| `GameJP`	The game object returned from one of the other methods.
region	`number`	Region code. (use the Region constant)