es7-typescript-starter
Version:
An es7/typescript starter for building javascript libraries
49 lines • 1.69 kB
JavaScript
;
/**
* Multiplies a value by 2. (Also a full example of Typedoc's functionality.)
*
* ### Example (es module)
* ```js
* import { double } from 'es7-typescript-starter'
* console.log(double(4))
* // => 8
* ```
*
* ### Example (commonjs)
* ```js
* var double = require('es7-typescript-starter').double;
* console.log(double(4))
* // => 8
* ```
*
* @param value Comment describing the `value` parameter.
* @returns Comment describing the return type.
* @anotherNote Some other value.
*/
function double(value) {
return value * 2;
}
exports.double = double;
/**
* Raise the value of the first parameter to the power of the second using the es7 `**` operator.
*
* ### Example (es module)
* ```js
* import { power } from 'es7-typescript-starter'
* console.log(power(2,3))
* // => 8
* ```
*
* ### Example (commonjs)
* ```js
* var power = require('es7-typescript-starter').power;
* console.log(power(2,3))
* // => 8
* ```
*/
function power(base, exponent) {
// This is a proposed es7 operator, which should be transpiled by Typescript
return Math.pow(base, exponent);
}
exports.power = power;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnVtYmVyT3BzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9udW1iZXJPcHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOzs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW9CRztBQUNILGdCQUF3QixLQUFhO0lBQ25DLE1BQU0sQ0FBQyxLQUFLLEdBQUcsQ0FBQyxDQUFBO0FBQ2xCLENBQUM7QUFGRCx3QkFFQztBQUVEOzs7Ozs7Ozs7Ozs7Ozs7O0dBZ0JHO0FBQ0gsZUFBdUIsSUFBWSxFQUFFLFFBQWdCO0lBQ25ELDRFQUE0RTtJQUM1RSxNQUFNLENBQUMsU0FBQSxJQUFJLEVBQUksUUFBUSxDQUFBLENBQUE7QUFDekIsQ0FBQztBQUhELHNCQUdDIn0=