docs: fix typo in BatteryCapacity object

smartcar · Mar 4, 2021 · 2ac163a · 2ac163a
1 parent 231b2ed
commit 2ac163a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/doc/readme.md b/doc/readme.md
@@ -49,7 +49,7 @@ Smartcar Node SDK documentation.
 <dd></dd>
 <dt><a href="#Battery">Battery</a> : <code>Object</code></dt>
 <dd></dd>
-<dt><a href="#BatteryCapcity">BatteryCapcity</a> : <code>Object</code></dt>
+<dt><a href="#BatteryCapacity">BatteryCapacity</a> : <code>Object</code></dt>
 <dd></dd>
 <dt><a href="#Charge">Charge</a> : <code>Object</code></dt>
 <dd></dd>
@@ -486,7 +486,7 @@ _To use this function, please contact us!_
     * [.tirePressure()](#Vehicle+tirePressure) ⇒ [<code>Promise.&lt;TirePressure&gt;</code>](#TirePressure)
     * [.fuel()](#Vehicle+fuel) ⇒ [<code>Promise.&lt;Fuel&gt;</code>](#Fuel)
     * [.battery()](#Vehicle+battery) ⇒ [<code>Promise.&lt;Battery&gt;</code>](#Battery)
-    * [.batteryCapacity()](#Vehicle+batteryCapacity) ⇒ <code>Promise.&lt;BatteryCapacity&gt;</code>
+    * [.batteryCapacity()](#Vehicle+batteryCapacity) ⇒ [<code>Promise.&lt;BatteryCapacity&gt;</code>](#BatteryCapacity)
     * [.charge()](#Vehicle+charge) ⇒ [<code>Promise.&lt;Charge&gt;</code>](#Charge)
     * [.vin()](#Vehicle+vin) ⇒ <code>Promise.&lt;String&gt;</code>
     * [.lock()](#Vehicle+lock) ⇒ [<code>Promise.&lt;ActionSuccess&gt;</code>](#ActionSuccess)
@@ -658,11 +658,11 @@ GET Vehicle.battery
 
 <a name="Vehicle+batteryCapacity"></a>
 
-### vehicle.batteryCapacity() ⇒ <code>Promise.&lt;BatteryCapacity&gt;</code>
+### vehicle.batteryCapacity() ⇒ [<code>Promise.&lt;BatteryCapacity&gt;</code>](#BatteryCapacity)
 GET Vehicle.batteryCapacity
 
 **Kind**: instance method of [<code>Vehicle</code>](#Vehicle)
-**Returns**: <code>Promise.&lt;BatteryCapacity&gt;</code> - A promise for info on the vehicle's battery capacity.
+**Returns**: [<code>Promise.&lt;BatteryCapacity&gt;</code>](#BatteryCapacity) - A promise for info on the vehicle's battery capacity.
 **Throws**:
 
 - <code>SmartcarError</code> - an instance of SmartcarError.
@@ -967,9 +967,9 @@ POST Vehicle.batch
   unitSystem: 'imperial',
 }
 ```
-<a name="BatteryCapcity"></a>
+<a name="BatteryCapacity"></a>
 
-## BatteryCapcity : <code>Object</code>
+## BatteryCapacity : <code>Object</code>
 **Kind**: global typedef
 **Properties**
 

diff --git a/lib/vehicle.js b/lib/vehicle.js
@@ -397,7 +397,7 @@ Vehicle.prototype.battery = function() {
 
 /**
  * @type {Object}
- * @typedef BatteryCapcity
+ * @typedef BatteryCapacity
  * @property {Object} data - The returned vehicle data.
  * @property {Number} data.capacity - The total capacity of the
  *  vehicle's battery (in kilowatt-hours)