time-to-botec/js/node_modules/@stdlib/assert/is-prng-like/README.md

isPRNGLike

Test if a value is PRNG-like.

Usage

var isPRNGLike = require( '@stdlib/assert/is-prng-like' );

isPRNGLike( value )

Tests if a value is PRNG-like.

var randu = require( '@stdlib/random/base/randu' );

var bool = isPRNGLike( randu );
// returns true

Notes

• The function is not rigorous and only checks for the existence of particular properties which should be bound to a seedable pseudorandom number generator (PRNG) function. The function's main use case is for testing that a provided value (loosely) conforms to a particular interface.

Examples

var randu = require( '@stdlib/random/base/randu' );
var isPRNGLike = require( '@stdlib/assert/is-prng-like' );

var bool = isPRNGLike( randu );
// returns true

bool = isPRNGLike( [ 1, 2, 3, 4 ] );
// returns false

bool = isPRNGLike( {} );
// returns false

bool = isPRNGLike( null );
// returns false