Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mseminatore committed Sep 20, 2017
1 parent bdc5e95 commit 1308d24
Showing 1 changed file with 6 additions and 37 deletions.
43 changes: 6 additions & 37 deletions docs/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,22 +100,16 @@
<dt><a href="#logoutAsync">logoutAsync(authToken)</a> ⇒ <code>Promise</code></dt>
<dd><p>Logout and invalidate the current auth token</p>
</dd>
<dt><a href="#vehicles">vehicles(options, callback)</a> ⇒ <code>Vehicle</code></dt>
<dd><p>Return vehicle information on the requested vehicle</p>
</dd>
<dt><a href="#vehicle">vehicle(options, callback)</a> ⇒ <code>Vehicle</code></dt>
<dd><p>Return vehicle information on the requested vehicle</p>
</dd>
<dt><a href="#vehicleAsync">vehicleAsync(options)</a> ⇒ <code>Promise</code></dt>
<dd><p>Return vehicle information on the requested vehicle</p>
</dd>
<dt><a href="#vehiclesAsync">vehiclesAsync(options)</a> ⇒ <code>Promise</code></dt>
<dd><p>Return vehicle information on the requested vehicle</p>
</dd>
<dt><a href="#allVehicles">allVehicles(options, callback)</a> ⇒ <code>Array.&lt;Vehicles&gt;</code></dt>
<dt><a href="#vehicles">vehicles(options, callback)</a> ⇒ <code>Array.&lt;Vehicles&gt;</code></dt>
<dd><p>Return vehicle information on ALL vehicles</p>
</dd>
<dt><a href="#allVehiclesAsync">allVehiclesAsync(options, callback)</a> ⇒ <code>Promise</code></dt>
<dt><a href="#vehiclesAsync">vehiclesAsync(options, callback)</a> ⇒ <code>Promise</code></dt>
<dd><p>Return vehicle information on ALL vehicles</p>
</dd>
<dt><a href="#get_command">get_command(options, command, callback)</a></dt>
Expand Down Expand Up @@ -599,19 +593,6 @@ Logout and invalidate the current auth token
| --- | --- | --- |
| authToken | <code>string</code> | Tesla provided OAuth token |

<a name="vehicles"></a>

## vehicles(options, callback) ⇒ <code>Vehicle</code>
Return vehicle information on the requested vehicle

**Kind**: global function
**Returns**: <code>Vehicle</code> - vehicle JSON data

| Param | Type | Description |
| --- | --- | --- |
| options | <code>[optionsType](#optionsType)</code> | options object |
| callback | <code>[nodeBack](#nodeBack)</code> | Node-style callback |

<a name="vehicle"></a>

## vehicle(options, callback) ⇒ <code>Vehicle</code>
Expand All @@ -637,21 +618,9 @@ Return vehicle information on the requested vehicle
| --- | --- | --- |
| options | <code>[optionsType](#optionsType)</code> | options object |

<a name="vehiclesAsync"></a>

## vehiclesAsync(options) ⇒ <code>Promise</code>
Return vehicle information on the requested vehicle

**Kind**: global function
**Returns**: <code>Promise</code> - vehicle JSON data

| Param | Type | Description |
| --- | --- | --- |
| options | <code>[optionsType](#optionsType)</code> | options object |

<a name="allVehicles"></a>
<a name="vehicles"></a>

## allVehicles(options, callback) ⇒ <code>Array.&lt;Vehicles&gt;</code>
## vehicles(options, callback) ⇒ <code>Array.&lt;Vehicles&gt;</code>
Return vehicle information on ALL vehicles

**Kind**: global function
Expand All @@ -662,9 +631,9 @@ Return vehicle information on ALL vehicles
| options | <code>[optionsType](#optionsType)</code> | options object |
| callback | <code>[nodeBack](#nodeBack)</code> | Node-style callback |

<a name="allVehiclesAsync"></a>
<a name="vehiclesAsync"></a>

## allVehiclesAsync(options, callback) ⇒ <code>Promise</code>
## vehiclesAsync(options, callback) ⇒ <code>Promise</code>
Return vehicle information on ALL vehicles

**Kind**: global function
Expand Down

0 comments on commit 1308d24

Please sign in to comment.