es7-typescript-starter
Version:
An es7/typescript starter for building javascript libraries
41 lines (40 loc) • 1.02 kB
TypeScript
/**
* 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.
*/
export declare function double(value: number): number;
/**
* 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
* ```
*/
export declare function power(base: number, exponent: number): number;