@stdlib/assert-is-prng-like NPM

isPRNGLike

Test if a value is PRNG-like.

Installation

npm install @stdlib/assert-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

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.