1.0.0 • Published 5 years ago
bedrock-stats-push-http v1.0.0
bedrock-stats-push-http
API Reference
Modules
Typedefs
bedrock-stats-push-http
bedrock-stats-push-http.addTarget(options) ⇒ Promise.<undefined>
Add an HTTP target that will receive stats reports.
Kind: static method of bedrock-stats-push-http
Returns: Promise.<undefined> - Resolves on completion.
| Param | Type | Default | Description |
|---|---|---|---|
| options | Object | The options to use. | |
| options.target | Target | The target options. | |
| options.source | Object | The source options. May contain arbitrary properties in addition to id. | |
| options.source.id | string | Identifies the source to the target. | |
| options.startDate | number | Date.now() | The start date for the first report sent to the target in ms since epoch. |
Target : Object
The target options.
Kind: global typedef
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| endpoint | string | The HTTP REST endpoint. | |
| monitorIds | Array.<string> | The stat monitors to report on. | |
| storageApi | string | The storage API to query. | |
| strictSSL | boolean | true | Use strictSSL when communicating with this target. |
1.0.0
5 years ago