Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/random/base/mt19937/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,17 @@ interface Random extends PRNG {
*/
(): number;

/**
* Returns a pseudorandom number on the interval `[0,1)`.
*
* @returns pseudorandom number
*
* @example
* var r = mt19937.normalized();
* // returns <number>
*/
normalized(): number;

/**
* Returns a 32-bit Mersenne Twister pseudorandom number generator.
*
Expand Down Expand Up @@ -168,6 +179,10 @@ interface Random extends PRNG {
* // returns <number>
*
* @example
* var v = mt19937.normalized();
* // returns <number>
*
* @example
* var rand = mt19937.factory({
* 'seed': 12345
* });
Expand Down
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/random/base/mt19937/docs/types/test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,18 @@ import mt19937 = require( './index' );
mt19937( 2, 3 ); // $ExpectError
}

// Attached to main export is a `normalized` method which returns a number...
{
mt19937.normalized(); // $ExpectType number
}

// The compiler throws an error if the `normalized` method is provided any number of arguments...
{
mt19937.normalized( true ); // $ExpectError
mt19937.normalized( 123 ); // $ExpectError
mt19937.normalized( 'abc' ); // $ExpectError
}

// Attached to main export is a `factory` method which returns a function...
{
mt19937.factory(); // $ExpectType NullaryFunction
Expand Down