Home - Skincrib/skincrib-client GitHub Wiki

@skincrib/skincrib-client is used to interact with the Skincrib API.

Note: All methods of @skincrib/skincrib-client are promised-based. Async/await is supported.

Constructor

Before interacting with anything on the api, you must first initiate an instance of @skincrib/skincrib-client. Example:

const Skincrib = require('@skincrib/skincrib-client');
const market = new Skincrib({
    key: 'KEY HERE',
    reconnect: true
});

Properties

key

• Type: String

The key property is the auto-generated Skincrib merchant api-key you received. @skincrib/skincrib-merchant will store this key in memory so that it is only necessary to provide it once.

reconnect

• Type: Boolean

The reconnect property is set to true by default. If set to false, the module will not auto-reconnect and authenticate to the websocket server if disconnected.