Auto-generated commit

stdlib-bot · stdlib-bot · commit 693d06ae9569 · 2022-10-11T21:45:33.000Z
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -20,6 +20,7 @@ Milan Raj <rajsite@users.noreply.github.com>
 Momtchil Momtchev <momtchil@momtchev.com>
 Ognjen Jevremović <ognjenjevremovic@users.noreply.github.com>
 Philipp Burckhardt <pburckhardt@outlook.com>
+Pranav <85227306+Pranavchiku@users.noreply.github.com>
 Ricky Reusser <rsreusser@gmail.com>
 Ryan Seal <splrk@users.noreply.github.com>
 Seyyed Parsa Neshaei <spneshaei@users.noreply.github.com>
diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts
@@ -22,15 +22,63 @@
 /* tslint:disable:max-file-line-count */
 
 import Function = require( './../../ctor' );
+import function2string = require( './../../to-string' );
 
 /**
 * Interface describing the `function` namespace.
 */
 interface Namespace {
 	/**
-	* TODO
+	* Returns a Function object.
+	*
+	* ## Notes
+	*
+	* -   Argument names must be strings corresponding to valid JavaScript parameters (i.e., a plain identifier, or, in environments supporting such parameters, a rest parameter or destructured parameter, optionally with a default).
+	* -   Creating `Function` objects with the `Function` constructor is less efficient than declaring a function via a function expression or a function statement.
+	* -   The `Function` constructor can be invoked without the `new` operator (using `new` and not using `new` both return a new `Function` object).
+	* -   The `Function` constructor creates functions which execute in the **global scope**. Hence, created functions **cannot** access variables local to the scope in which functions were created.
+	*
+	* @param argNames - parameter names
+	* @param body - function body
+	* @returns function
+	*
+	* @example
+	* var add = new ns.Function( 'x', 'y', 'return x + y' );
+	*
+	* var v = add( 1, 2 );
+	* // returns 3
 	*/
 	Function: typeof Function;
+
+	/**
+	* Returns a string representing the source code of a provided function.
+	*
+	* ## Notes
+	*
+	* -   If called on built-in functions, functions created by `Function.prototype.bind()`, or other non-JavaScript functions, the function returns a "native" function string similar to the following:
+	*
+	*     ```text
+	*     "function foo() { [native code] }"
+	*     ```
+	*
+	*     For intrinsic object methods and functions, `foo` is the initial name of the function.
+	*
+	* -   If called on a function created by the `Function` constructor, the function returns the source code of a synthesized function declaration having the name "anonymous" and using the provided parameters and function body.
+	*
+	* -   Starting in ES2018, the ECMAScript specification requires that the returned string contain the exact same source code as it was declared, including any whitespace and/or comments. If the host is unable to access the source code, the specification requires that the returned string be the native function string.
+	*
+	* @param fcn - input function
+	* @returns string representing function source code
+	*
+	* @example
+	* function add( x, y ) {
+	*     return x + y;
+	* }
+	*
+	* var str = ns.function2string( add );
+	* // e.g., returns 'function add( x, y ) {\n    return x + y;\n}'
+	*/
+	function2string: typeof function2string;
 }
 
 /**
