Add support for additional properties and document options

Author: kgryte

lib/node_modules/@stdlib/random/base/betaprime/lib/factory.js

@@ -20,8 +20,9 @@
 
 // MODULES //
 
-var defineProperty = require( '@stdlib/utils/define-property' );
 var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
+var setReadOnlyAccessor = require( '@stdlib/utils/define-read-only-accessor' );
+var setReadWriteAccessor = require( '@stdlib/utils/define-read-write-accessor' );
 var isObject = require( '@stdlib/assert/is-plain-object' );
 var gammaFactory = require( '@stdlib/random/base/gamma' ).factory;
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
@@ -37,10 +38,14 @@ var betaprime0 = require( './betaprime.js' );
 * @param {PositiveNumber} [alpha] - first shape parameter
 * @param {PositiveNumber} [beta] - second shape parameter
 * @param {Options} [options] - function options
-* @param {*} [options.seed] - pseudorandom number generator seed
+* @param {(uinteger32|Collection<uinteger32>)} [options.seed] - pseudorandom number generator seed
+* @param {Uint32Array} [options.state] - pseudorandom number generator state
+* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
 * @throws {TypeError} `alpha` must be a positive number
 * @throws {TypeError} `beta` must be a positive number
-* @throws {TypeError} `options` must be an object
+* @throws {TypeError} options argument must be an object
+* @throws {TypeError} must provide valid options
+* @throws {Error} must provide a valid state
 * @returns {Function} pseudorandom number generator
 *
 * @example
@@ -94,19 +99,55 @@ function factory() {
 		prng = betaprime1;
 	}
 	setReadOnly( prng, 'NAME', 'betaprime' );
-	setReadOnly( prng, 'seed', rand.seed );
-	defineProperty( prng, 'state', {
-		'configurable': false,
-		'enumerable': true,
-		'get': getState,
-		'set': setState
-	});
-	setReadOnly( prng, 'stateLength', rand.stateLength );
-	setReadOnly( prng, 'byteLength', rand.byteLength );
+	setReadOnlyAccessor( prng, 'seed', getSeed );
+	setReadOnlyAccessor( prng, 'seedLength', getSeedLength );
+	setReadWriteAccessor( prng, 'state', getState, setState );
+	setReadOnlyAccessor( prng, 'stateLength', getStateLength );
+	setReadOnlyAccessor( prng, 'byteLength', getStateSize );
 	setReadOnly( prng, 'PRNG', rand );
 
 	return prng;
 
+	/**
+	* Returns the PRNG seed.
+	*
+	* @private
+	* @returns {Uint32Array} seed
+	*/
+	function getSeed() {
+		return rand.seed;
+	}
+
+	/**
+	* Returns the PRNG seed length.
+	*
+	* @private
+	* @returns {PositiveInteger} seed length
+	*/
+	function getSeedLength() {
+		return rand.seedLength;
+	}
+
+	/**
+	* Returns the PRNG state length.
+	*
+	* @private
+	* @returns {PositiveInteger} state length
+	*/
+	function getStateLength() {
+		return rand.stateLength;
+	}
+
+	/**
+	* Returns the PRNG state size (in bytes).
+	*
+	* @private
+	* @returns {PositiveInteger} state size (in bytes)
+	*/
+	function getStateSize() {
+		return rand.byteLength;
+	}
+
 	/**
 	* Returns the current pseudorandom number generator state.
 	*
@@ -122,6 +163,8 @@ function factory() {
 	*
 	* @private
 	* @param {Uint32Array} s - generator state
+	* @throws {TypeError} must provide a `Uint32Array`
+	* @throws {Error} must provide a valid state
 	*/
 	function setState( s ) {
 		rand.state = s;