Skip to content

Commit c2a4860

Browse files
committed
feat: update function TypeScript declarations
--- 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: na - task: lint_license_headers status: passed ---
1 parent 27665f5 commit c2a4860

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/function/docs/types

lib/node_modules/@stdlib/function/docs/types/index.d.ts

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
/* eslint-disable max-lines */
2222

2323
import Function = require( '@stdlib/function/ctor' );
24+
import thunk = require( '@stdlib/function/thunk' );
2425
import function2string = require( '@stdlib/function/to-string' );
2526

2627
/**
@@ -49,6 +50,27 @@ interface Namespace {
4950
*/
5051
Function: typeof Function;
5152

53+
/**
54+
* Returns a thunk.
55+
*
56+
* @param fcn - function to convert to a thunk
57+
* @param args - function args
58+
* @returns thunk
59+
*
60+
* @example
61+
* var add = require( '@stdlib/number/float64/base/add' );
62+
*
63+
* var f = ns.thunk( add, 2, 3 );
64+
* // returns <Function>
65+
*
66+
* // ...
67+
*
68+
* // Evaluate the ns.thunk:
69+
* var v = f();
70+
* // returns 5
71+
*/
72+
thunk: typeof thunk;
73+
5274
/**
5375
* Returns a string representing the source code of a provided function.
5476
*

0 commit comments

Comments
 (0)