Keymetrics

Keymetrics

new Keymetrics(opts)

Parameters:
Name Type Description
opts object The options are passed to the children instances
Properties
Name Type Description
refresh_token string [Required] Refresh token (retrieved from Keymetrics dashboard)
token_type string [Required] Type: 'refresh_token' or 'access_token'
access_token string [Optional] Access token
public_key string [Optional] Bucket public key
realtime string [Optional] When true, attempts realtime connection on .init()
public_key string [Optional] Bucket id
host string [Optional] Base url used (default 'http://app.keymetrics.io:3000')
basePath string [Optional] Base API path (default '/api')
bus function [Optional] EventEmitter2 instance
Source:

Classes

auth
bucket
realtime
user

Methods

init(callback)

Start the Keymetrics connection
Parameters:
Name Type Description
callback function Runs once connection is complete
Source: