Connection packages to connect to Cubic API nodes. Choose your target platform from the available branches.

Installation

npm install cubic-client

Other Supported Platforms

Usage

const Client = require('cubic-client')
const client = new Client()

cubic.get('/foo').then(res => console.log(res.body)) // bar

Configuration

const Client = require('cubic-client')
const client = new Client({key: value})

API

RESTful methods

client.get(url)

Sends a GET request to the API-Node

client.post(url, body)

Sends a POST request to the API-Node

client.put(url, body)

Sends a PUT request to the API-Node

client.patch(url, body)

Sends a PATCH request to the API-Node

client.delete(url, body)

Sends a DELETE request to the API-Node

Pub/Sub

client.subscribe(endpoint, fn)

Subscribe to updates on a specific endpoint.

Authentication

client.login(user, secret)

Re-authorizes as a specific user at runtime. Usually users should be logged in through the constructor options.

client.setRefreshToken(token)

Manually set the refresh token. This way user credentials needn't be exposed.

client.getRefreshToken()

Retrieve current refresh token. Will await any existing authentication process. Useful if the initial login can be done through user/pass but the refresh token needs to be stored for subsequent logins.

client.setAccessToken(token)

Manually set the access token. This will expire on the next refresh.

client.getRefreshToken()

Retrieve current access token. Will await any existing authentication process.

Socket.io

client.on(ev, fn)

Listens to specific Socket.io event, then runs the given function with the received data

client.emit(ev, data)

Emits event via Socket.io client to server

License

MIT