Skip to content
This repository has been archived by the owner on May 7, 2020. It is now read-only.

balena-io-modules/resin-cli-events

Repository files navigation


resin-cli-events is deprecated, and no longer in use. You might be looking for resin-analytics.


resin-cli-events

npm version dependencies Build Status Build status

Join our online chat at Gitter chat

Resin.io CLI event client.

Role

The intention of this module is to provide an easy interface for the Resin CLI to send analytics.

Installation

Install resin-cli-events by running:

$ npm install --save resin-cli-events

Documentation

events.send(event, [options])

Any extra option apart from application and device will be sent to the server as extra event data.

Consult https://github.com/resin-io/resin-event-log for available events.

Kind: static method of events
Summary: Send a CLI event
Access: public

Param Type Description
event String event name
[options] Object event options
[options.application] Number application id
[options.device] Number device id

Example

events.send('application.create', application: 27)

Support

If you're having any problem, please raise an issue on GitHub and the Resin.io team will be happy to help.

Tests

Run the test suite by doing:

$ gulp test

Contribute

Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:

$ gulp lint

License

The project is licensed under the Apache 2.0 license.