1.0.5 • Published 7 years ago
resin-cli-events v1.0.5
resin-cli-events
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
- Issue Tracker: github.com/resin-io/resin-cli-events/issues
- Source Code: github.com/resin-io/resin-cli-events
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.