scorenix-js v0.0.2

Scorenix

Scorenix is a JavaScript client library

• event logging
• error logging
• player cloud save
• leaderboards

Installation and Usage

To install a SDK, simply add the high-level package, for example:

npm install --save scorenix-js

Build

1. Install dependencies: npm install
2. Build: npm run build

Quick Start

Include a reference to the Scorenix library

<script src="/scorenix.min.js"></script>

scorenix.init

Initializes the scorenix client.

scorenix.init(API_KEY, { debug:Boolean });

API_KEY: application api key options: configurations options.debug: logger debug mode. True will display errors in console.

lognetic.writeException

Sends a error exception.

lognetic.writeException(error, data);

error (required): a JavaScript Error object data: additional data to send(must contains values of string, number, or boolean)

lognetic.writeMessage

Sends a custom info-level message.

lognetic.writeMessage(message, data);

message (required): the custom message to log data: additional data to send(must contains values of string, number, or boolean)

scorenix.writeMessage

Sends a custom info-level message. Shorthand of scorenix.lognetic.writeMessage

scorenix.writeMessage(message);

message (required): the custom message to log data argument cannot be passed.

lognetic.setMetaContext

Assigns custom meta data that will be sent along with each exception.

lognetic.setMetaContext(data);

data (required): custom meta data, can be user to store user details

lognetic.setAppVersion

Allows you to set your application version.

lognetic.setAppVersion(version);

version (required): application version as string

License

BSD 3-Clause