diff --git a/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/to-json/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/to-json/docs/types/index.d.ts index 7e8ea4930deb..0aea2ccf39b8 100644 --- a/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/to-json/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/to-json/docs/types/index.d.ts @@ -68,6 +68,59 @@ interface Results { method: string; } +/** +* Interface describing a serialized results object. +*/ +interface ResultsJSON { + /** + * Boolean indicating whether the null hypothesis was rejected. + */ + rejected: boolean; + + /** + * Alternative hypothesis. + */ + alternative: string; + + /** + * Significance level. + */ + alpha: number; + + /** + * p-value. + */ + pValue: number; + + /** + * Test statistic. + */ + statistic: number; + + /** + * Confidence interval. + */ + ci: { + type: string; + data: Array; + }; + + /** + * Value of the mean under the null hypothesis. + */ + nullValue: number; + + /** + * Standard error of the mean. + */ + sd: number; + + /** + * Test method. + */ + method: string; +} + /** * Serializes a one-sample Z-test results object as a JSON object. * @@ -92,7 +145,7 @@ interface Results { * var obj = res2json( results ); * // returns {...} */ -declare function res2json( results: Results ): Results; +declare function res2json( results: Results ): ResultsJSON; // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/to-json/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/to-json/docs/types/test.ts index f1bfa2bcb772..2fa69a039cce 100644 --- a/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/to-json/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/to-json/docs/types/test.ts @@ -34,7 +34,7 @@ import res2json = require( './index' ); 'alternative': 'two-sided', 'method': 'One-sample Z-test' }; - res2json( res ); // $ExpectType Results + res2json( res ); // $ExpectType ResultsJSON } // The compiler throws an error if not provided a results object...