Merge pull request #12 from firien/doc-update

remove colorAndDistance event from DuploTrainBase docs
This commit is contained in:
Nathan Kellenicki 2019-01-18 15:57:29 -08:00 committed by GitHub
commit 8180c6b99c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 6 additions and 29 deletions

14
DOCS.md
View File

@ -1581,7 +1581,6 @@ A combined color and distance event, emits when the sensor is activated.
* [.getHubType()](#Hub+getHubType) ⇒ [<code>HubType</code>](#HubType)
* [.getPortDeviceType(port)](#Hub+getPortDeviceType) ⇒ [<code>DeviceType</code>](#DeviceType)
* ["color" (port, color)](#LPF2Hub+event_color)
* ["colorAndDistance" (port, color, distance)](#LPF2Hub+event_colorAndDistance)
* ["speed" (port, speed)](#LPF2Hub+event_speed)
<a name="new_DuploTrainBase_new"></a>
@ -1867,19 +1866,6 @@ Emits when a color sensor is activated.
| port | <code>string</code> |
| color | [<code>Color</code>](#Color) |
<a name="LPF2Hub+event_colorAndDistance"></a>
### "colorAndDistance" (port, color, distance)
A combined color and distance event, emits when the sensor is activated.
**Kind**: event emitted by [<code>DuploTrainBase</code>](#DuploTrainBase)
| Param | Type | Description |
| --- | --- | --- |
| port | <code>string</code> | |
| color | [<code>Color</code>](#Color) | |
| distance | <code>number</code> | Distance, in millimeters. |
<a name="LPF2Hub+event_speed"></a>
### "speed" (port, speed)

View File

@ -1674,7 +1674,6 @@ A combined color and distance event, emits when the sensor is activated.
* [.getHubType()](#Hub+getHubType) ⇒ [<code>HubType</code>](#HubType)
* [.getPortDeviceType(port)](#Hub+getPortDeviceType) ⇒ [<code>DeviceType</code>](#DeviceType)
* ["color" (port, color)](#LPF2Hub+event_color)
* ["colorAndDistance" (port, color, distance)](#LPF2Hub+event_colorAndDistance)
* ["speed" (port, speed)](#LPF2Hub+event_speed)
<a name="new_DuploTrainBase_new"></a>
@ -1960,19 +1959,6 @@ Emits when a color sensor is activated.
| port | <code>string</code> |
| color | [<code>Color</code>](#Color) |
<a name="LPF2Hub+event_colorAndDistance"></a>
### "colorAndDistance" (port, color, distance)
A combined color and distance event, emits when the sensor is activated.
**Kind**: event emitted by [<code>DuploTrainBase</code>](#DuploTrainBase)
| Param | Type | Description |
| --- | --- | --- |
| port | <code>string</code> | |
| color | [<code>Color</code>](#Color) | |
| distance | <code>number</code> | Distance, in millimeters. |
<a name="LPF2Hub+event_speed"></a>
### "speed" (port, speed)

2
package-lock.json generated
View File

@ -1,6 +1,6 @@
{
"name": "node-poweredup",
"version": "1.4.8",
"version": "1.5.1",
"lockfileVersion": 1,
"requires": true,
"dependencies": {

View File

@ -25,6 +25,11 @@ export class DuploTrainBase extends LPF2Hub {
* @ignore
*/
/**
* @event DuploTrainBase#colorAndDistance
* @ignore
*/
/**
* @event DuploTrainBase#tilt
* @ignore