fix: correct function signature of TypeScript declaration

Planeshifter · Planeshifter · commit 266be21558c8 · 2025-09-10T15:17:18.000-05:00
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/random/iter/frechet/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/iter/frechet/docs/types/index.d.ts
@@ -93,6 +93,7 @@ interface Iterator<T> extends TypedIterator<T> {
 *
 * @param alpha - shape parameter
 * @param s - rate parameter
+* @param m - location parameter
 * @param options - function options
 * @throws `alpha` must be a positive number
 * @throws `s` must be a positive number
@@ -101,7 +102,7 @@ interface Iterator<T> extends TypedIterator<T> {
 * @returns iterator
 *
 * @example
-* var iter = iterator( 2.0, 5.0 );
+* var iter = iterator( 2.0, 5.0, 3.0 );
 *
 * var r = iter.next().value;
 * // returns <number>
@@ -114,7 +115,7 @@ interface Iterator<T> extends TypedIterator<T> {
 *
 * // ...
 */
-declare function iterator( alpha: number, s: number, options?: Options ): Iterator<number>;
+declare function iterator( alpha: number, s: number, m: number, options?: Options ): Iterator<number>;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/random/iter/frechet/docs/types/test.ts b/lib/node_modules/@stdlib/random/iter/frechet/docs/types/test.ts
@@ -23,9 +23,9 @@ import iterator = require( './index' );
 
 // The function returns an iterator...
 {
-	iterator( 2.0, 5.0 ); // $ExpectType Iterator<number>
-	iterator( 2.0, 5.0, {} ); // $ExpectType Iterator<number>
-	iterator( 2.0, 5.0, { 'iter': 10 } ); // $ExpectType Iterator<number>
+	iterator( 2.0, 5.0, 3.0 ); // $ExpectType Iterator<number>
+	iterator( 2.0, 5.0, 3.0, {} ); // $ExpectType Iterator<number>
+	iterator( 2.0, 5.0, 3.0, { 'iter': 10 } ); // $ExpectType Iterator<number>
 }
 
 // The compiler throws an error if the function is provided invalid input arguments...
@@ -39,4 +39,5 @@ import iterator = require( './index' );
 {
 	iterator(); // $ExpectError
 	iterator( 2.0 ); // $ExpectError
+	iterator( 2.0, 5.0 ); // $ExpectError
 }

Original file line number	Diff line number	Diff line change
`@@ -93,6 +93,7 @@ interface Iterator<T> extends TypedIterator<T> {`
`93`	`93`	`*`
`94`	`94`	`* @param alpha - shape parameter`
`95`	`95`	`* @param s - rate parameter`
	`96`	`+* @param m - location parameter`
`96`	`97`	`* @param options - function options`
`97`	`98`	* @throws `alpha` must be a positive number
`98`	`99`	* @throws `s` must be a positive number
`@@ -101,7 +102,7 @@ interface Iterator<T> extends TypedIterator<T> {`
`101`	`102`	`* @returns iterator`
`102`	`103`	`*`
`103`	`104`	`* @example`
`104`		`-* var iter = iterator( 2.0, 5.0 );`
	`105`	`+* var iter = iterator( 2.0, 5.0, 3.0 );`
`105`	`106`	`*`
`106`	`107`	`* var r = iter.next().value;`
`107`	`108`	`* // returns <number>`
`@@ -114,7 +115,7 @@ interface Iterator<T> extends TypedIterator<T> {`
`114`	`115`	`*`
`115`	`116`	`* // ...`
`116`	`117`	`*/`
`117`		`-declare function iterator( alpha: number, s: number, options?: Options ): Iterator<number>;`
	`118`	`+declare function iterator( alpha: number, s: number, m: number, options?: Options ): Iterator<number>;`
`118`	`119`
`119`	`120`
`120`	`121`	`// EXPORTS //`
Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,9 @@ import iterator = require( './index' );`
`23`	`23`
`24`	`24`	`// The function returns an iterator...`
`25`	`25`	`{`
`26`		`- iterator( 2.0, 5.0 ); // $ExpectType Iterator<number>`
`27`		`- iterator( 2.0, 5.0, {} ); // $ExpectType Iterator<number>`
`28`		`- iterator( 2.0, 5.0, { 'iter': 10 } ); // $ExpectType Iterator<number>`
	`26`	`+ iterator( 2.0, 5.0, 3.0 ); // $ExpectType Iterator<number>`
	`27`	`+ iterator( 2.0, 5.0, 3.0, {} ); // $ExpectType Iterator<number>`
	`28`	`+ iterator( 2.0, 5.0, 3.0, { 'iter': 10 } ); // $ExpectType Iterator<number>`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`// The compiler throws an error if the function is provided invalid input arguments...`
`@@ -39,4 +39,5 @@ import iterator = require( './index' );`
`39`	`39`	`{`
`40`	`40`	`iterator(); // $ExpectError`
`41`	`41`	`iterator( 2.0 ); // $ExpectError`
	`42`	`+ iterator( 2.0, 5.0 ); // $ExpectError`
`42`	`43`	`}`