time-to-botec/squiggle/node_modules/@stdlib/assert/is-prng-like/lib/main.js

57 lines
1.2 KiB
JavaScript
Raw Normal View History

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
// MODULES //
var isFunction = require( './../../is-function' );
var hasOwnProp = require( './../../has-own-property' );
// MAIN //
/**
* Tests if a value is PRNG-like.
*
* @param {*} v - value to test
* @returns {boolean} boolean indicating if a value is PRNG-like
*
* @example
* var randu = require( '@stdlib/random/base/randu' );
*
* var bool = isPRNGLike( randu );
* // returns true
*
* bool = isPRNGLike( [] );
* // returns false
*/
function isPRNGLike( v ) {
return (
isFunction( v ) &&
typeof v.NAME === 'string' &&
hasOwnProp( v, 'state' ) &&
hasOwnProp( v, 'seed' )
);
}
// EXPORTS //
module.exports = isPRNGLike;