Merge pull request #52 from ays14/power

add method to calculate power of a number

docs/aFunc/doPower.md

@@ -0,0 +1,31 @@
+# doPower()
+
+> This function is used to get the power/exponent of a number.
+
+- @param {number} base `x` -> base number, whose power is calculated
+- @param {number} exponent `y` -> power/index for the number
+- @return {number} The power/exponent of the base number or say `x^y`
+
+## Syntax
+
+function(x, y) { ..code.. }
+
+## Parameters
+
+The function takes two parameters and return the output.
+
+## Example
+
+### Code:
+```js
+const calculator = require('all-round-calculator');
+console.log(calculator.power(25,2));
+```
+
+### Output:
+```bash
+625
+```
+
+---
+

docs/functions.md

@@ -18,6 +18,7 @@ Currently we have almost 15+ functions in our npm package. Some of them are list
     <!-- * [toOct()](aFunc/toOct.md):- Decimal to Octal -->
     <!-- * [toTri()](aFunc/toTri.md):- Decimal to Trinary -->
   * [doMod()](aFunc/doMod.md):- Get the modulus
+  * [doPower()](aFunc/doPower.md):- Get the power/exponent of a number
 
 * ** Miscellaneous Functions**
 

package/index.js

@@ -152,6 +152,16 @@ function getRandom() {
   return Math.floor(Math.random() * 1000);
 }
 
+/**
+ * Calculate power of a number, as x^y
+ * @param {number} base x -> base number, whose power is calculated
+ * @param {number} exponent y -> power/index for the number
+ * @returns 
+ */
+function doPower(base, exponent) {
+  return Math.pow(base, exponent);
+}
+
 // Export functions
 module.exports = {
   doAdd,
@@ -182,5 +192,6 @@ module.exports = {
   doFactorial,
   doMax,
   doMin,
+  doPower,
   calculatesin,
 };