Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-12-23)
+## Unreleased (2025-12-24)
 
 <section class="features">
 
@@ -3526,6 +3526,10 @@ A total of 559 issues were closed in this release:
 
 <details>
 
+-   [`c216219`](https://github.com/stdlib-js/stdlib/commit/c2162190116f0953296c56c41b7480c8c050ab7e) - **docs:** fix JSDoc parameter type in `stats/base/ztest/one-sample/results` constructors _(by Philipp Burckhardt)_
+-   [`518e88e`](https://github.com/stdlib-js/stdlib/commit/518e88ef1c3de77e44a760fcabb1aa7ebd4ee72d) - **chore:** use literal since setter accepts strings directly _(by Philipp Burckhardt)_
+-   [`59455b6`](https://github.com/stdlib-js/stdlib/commit/59455b661612d4c4ed47c25d3077884b985742fc) - **docs:** add `toString`, `toJSON`, and `toDataView` declarations to Z-test results packages _(by Philipp Burckhardt)_
+-   [`0a437aa`](https://github.com/stdlib-js/stdlib/commit/0a437aad60abb626a22840c9bad66414b627749f) - **chore:** remove usage of unsupported option _(by Philipp Burckhardt)_
 -   [`c17e5f2`](https://github.com/stdlib-js/stdlib/commit/c17e5f26a44218e7cc295e5360f681c1d36fee13) - **feat:** add `stats/base/ndarray/stdev` [(#9248)](https://github.com/stdlib-js/stdlib/pull/9248) _(by Pratik, Athan Reines)_
 -   [`61046bb`](https://github.com/stdlib-js/stdlib/commit/61046bb1c95923825493592bf78808fa1b18abc5) - **test:** add missing TypeScript declaration tests _(by Philipp Burckhardt)_
 -   [`595918c`](https://github.com/stdlib-js/stdlib/commit/595918c57777524dd8533b80a429c7d331f87444) - **feat:** add `stats/strided/midrange` [(#9298)](https://github.com/stdlib-js/stdlib/pull/9298) _(by Sachin Pangal, Athan Reines)_

base/ztest/one-sample/results/factory/docs/repl.txt

@@ -16,7 +16,7 @@
     --------
     > var R = {{alias}}( 'float64' );
     > var r = new R();
-    > r.toString( { 'format': 'linear' } )
+    > r.toString()
     <string>
 
     See Also

base/ztest/one-sample/results/factory/docs/types/index.d.ts

@@ -68,6 +68,21 @@ interface Results<T> {
 	sd?: number;
 }
 
+/**
+* Interface describing options when serializing a results object to a string.
+*/
+interface ToStringOptions {
+	/**
+	* Number of digits to display after decimal points. Default: `4`.
+	*/
+	digits?: number;
+
+	/**
+	* Boolean indicating whether to show the test decision. Default: `true`.
+	*/
+	decision?: boolean;
+}
+
 /**
 * Interface describing a results data structure.
 */
@@ -126,6 +141,28 @@ declare class ResultsStruct<T> {
 	* Test method.
 	*/
 	method: string;
+
+	/**
+	* Serializes a results object as a formatted string.
+	*
+	* @param options - options object
+	* @returns serialized results
+	*/
+	toString( options?: ToStringOptions ): string;
+
+	/**
+	* Serializes a results object as a JSON object.
+	*
+	* @returns serialized object
+	*/
+	toJSON(): object;
+
+	/**
+	* Returns a DataView of a results object.
+	*
+	* @returns DataView
+	*/
+	toDataView(): DataView;
 }
 
 /**

base/ztest/one-sample/results/factory/docs/types/test.ts

@@ -53,7 +53,7 @@ import resultsFactory = require( './index' );
 	const r3 = new Results( new ArrayBuffer( 80 ), 8, 16 ); // $ExpectType ResultsStruct<Float64Array>
 }
 
-// The returned constructor can be invoked without `new`...
+// The returned function can be invoked without `new`...
 {
 	const Results = resultsFactory( 'float64' );
 
@@ -171,3 +171,31 @@ import resultsFactory = require( './index' );
 	new Results( new ArrayBuffer( 80 ), 8, {} ); // $ExpectError
 	new Results( new ArrayBuffer( 80 ), 8, ( x: number ): number => x ); // $ExpectError
 }
+
+// The results object has a `toString` method...
+{
+	const Results = resultsFactory( 'float64' );
+	const r = new Results( {} );
+
+	r.toString(); // $ExpectType string
+	r.toString( {} ); // $ExpectType string
+	r.toString( { 'digits': 4 } ); // $ExpectType string
+	r.toString( { 'decision': true } ); // $ExpectType string
+	r.toString( { 'digits': 4, 'decision': true } ); // $ExpectType string
+}
+
+// The results object has a `toJSON` method...
+{
+	const Results = resultsFactory( 'float64' );
+	const r = new Results( {} );
+
+	r.toJSON(); // $ExpectType object
+}
+
+// The results object has a `toDataView` method...
+{
+	const Results = resultsFactory( 'float64' );
+	const r = new Results( {} );
+
+	r.toDataView(); // $ExpectType DataView
+}

base/ztest/one-sample/results/float32/README.md

@@ -282,9 +282,7 @@ var results = new Results({
     'alternative': 'two-sided'
 });
 
-var str = results.toString({
-    'format': 'linear'
-});
+var str = results.toString();
 console.log( str );
 ```
 

base/ztest/one-sample/results/float32/docs/repl.txt

@@ -21,7 +21,7 @@
     Examples
     --------
     > var r = new {{alias}}();
-    > r.toString( { 'format': 'linear' } )
+    > r.toString()
     <string>
 
     See Also

base/ztest/one-sample/results/float32/docs/types/index.d.ts

@@ -68,6 +68,21 @@ interface Results {
 	sd?: number;
 }
 
+/**
+* Interface describing options when serializing a results object to a string.
+*/
+interface ToStringOptions {
+	/**
+	* Number of digits to display after decimal points. Default: `4`.
+	*/
+	digits?: number;
+
+	/**
+	* Boolean indicating whether to show the test decision. Default: `true`.
+	*/
+	decision?: boolean;
+}
+
 /**
 * Interface describing a results data structure.
 */
@@ -126,6 +141,28 @@ declare class ResultsStruct {
 	* Test method.
 	*/
 	method: string;
+
+	/**
+	* Serializes a results object as a formatted string.
+	*
+	* @param options - options object
+	* @returns serialized results
+	*/
+	toString( options?: ToStringOptions ): string;
+
+	/**
+	* Serializes a results object as a JSON object.
+	*
+	* @returns serialized object
+	*/
+	toJSON(): object;
+
+	/**
+	* Returns a DataView of a results object.
+	*
+	* @returns DataView
+	*/
+	toDataView(): DataView;
 }
 
 /**

base/ztest/one-sample/results/float32/docs/types/test.ts

@@ -21,7 +21,7 @@ import Results = require( './index' );
 
 // TESTS //
 
-// The constructor returns a results object...
+// The function returns a results object...
 {
 	// eslint-disable-next-line @typescript-eslint/no-unused-vars
 	const r0 = new Results( {} ); // $ExpectType ResultsStruct
@@ -36,7 +36,7 @@ import Results = require( './index' );
 	const r3 = new Results( new ArrayBuffer( 80 ), 8, 16 ); // $ExpectType ResultsStruct
 }
 
-// The constructor can be invoked without `new`...
+// The function can be invoked without `new`...
 {
 	// eslint-disable-next-line @typescript-eslint/no-unused-vars
 	const r0 = Results( {} ); // $ExpectType ResultsStruct
@@ -115,3 +115,28 @@ import Results = require( './index' );
 	new Results( new ArrayBuffer( 80 ), 8, {} ); // $ExpectError
 	new Results( new ArrayBuffer( 80 ), 8, ( x: number ): number => x ); // $ExpectError
 }
+
+// The results object has a `toString` method...
+{
+	const r = new Results( {} );
+
+	r.toString(); // $ExpectType string
+	r.toString( {} ); // $ExpectType string
+	r.toString( { 'digits': 4 } ); // $ExpectType string
+	r.toString( { 'decision': true } ); // $ExpectType string
+	r.toString( { 'digits': 4, 'decision': true } ); // $ExpectType string
+}
+
+// The results object has a `toJSON` method...
+{
+	const r = new Results( {} );
+
+	r.toJSON(); // $ExpectType object
+}
+
+// The results object has a `toDataView` method...
+{
+	const r = new Results( {} );
+
+	r.toDataView(); // $ExpectType DataView
+}

base/ztest/one-sample/results/float32/examples/index.js

@@ -32,7 +32,5 @@ var results = new Results({
 	'alternative': 'two-sided'
 });
 
-var str = results.toString({
-	'format': 'linear'
-});
+var str = results.toString();
 console.log( str );

base/ztest/one-sample/results/float32/lib/main.js

@@ -31,7 +31,7 @@ var factory = require( './../../../../../../base/ztest/one-sample/results/factor
 * @name Results
 * @constructor
 * @type {Function}
-* @param {ArrayBuffer} [buffer] - underlying byte buffer
+* @param {(ArrayBuffer|Object)} [arg] - underlying byte buffer or data object
 * @param {NonNegativeInteger} [byteOffset] - byte offset
 * @param {NonNegativeInteger} [byteLength] - maximum byte length
 * @returns {Results} results object