diff --git a/doc/readme.md b/doc/readme.md index 19aaff7..2158b02 100644 --- a/doc/readme.md +++ b/doc/readme.md @@ -49,7 +49,7 @@ Smartcar Node SDK documentation.
Object
Object
Object
Object
Promise.<TirePressure>
](#TirePressure)
* [.fuel()](#Vehicle+fuel) ⇒ [Promise.<Fuel>
](#Fuel)
* [.battery()](#Vehicle+battery) ⇒ [Promise.<Battery>
](#Battery)
- * [.batteryCapacity()](#Vehicle+batteryCapacity) ⇒ Promise.<BatteryCapacity>
+ * [.batteryCapacity()](#Vehicle+batteryCapacity) ⇒ [Promise.<BatteryCapacity>
](#BatteryCapacity)
* [.charge()](#Vehicle+charge) ⇒ [Promise.<Charge>
](#Charge)
* [.vin()](#Vehicle+vin) ⇒ Promise.<String>
* [.lock()](#Vehicle+lock) ⇒ [Promise.<ActionSuccess>
](#ActionSuccess)
@@ -658,11 +658,11 @@ GET Vehicle.battery
-### vehicle.batteryCapacity() ⇒ Promise.<BatteryCapacity>
+### vehicle.batteryCapacity() ⇒ [Promise.<BatteryCapacity>
](#BatteryCapacity)
GET Vehicle.batteryCapacity
**Kind**: instance method of [Vehicle
](#Vehicle)
-**Returns**: Promise.<BatteryCapacity>
- A promise for info on the vehicle's battery capacity.
+**Returns**: [Promise.<BatteryCapacity>
](#BatteryCapacity) - A promise for info on the vehicle's battery capacity.
**Throws**:
- SmartcarError
- an instance of SmartcarError.
@@ -967,9 +967,9 @@ POST Vehicle.batch
unitSystem: 'imperial',
}
```
-
+
-## BatteryCapcity : Object
+## BatteryCapacity : Object
**Kind**: global typedef
**Properties**
diff --git a/lib/vehicle.js b/lib/vehicle.js
index 38ee2d2..d98e1a8 100644
--- 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)