Home

function: functions


functions(object: Object): Array

Creates an array of function property names from own enumerable properties of `object`.

Example(s):

function Foo() {
  this.a = constant('a')
  this.b = constant('b')
}

Foo.prototype.c = constant('c')

functions(new Foo)
// => ['a', 'b']

Params:

Name Type Attribute Description
object The object to inspect.

Returns:

Array

  {
    "comment": "/**\r\n * Creates an array of function property names from own enumerable properties\r\n * of `object`.\r\n *\r\n * @since 0.1.0\r\n * @category Object\r\n * @param {Object} object The object to inspect.\r\n * @returns {Array} Returns the function names.\r\n * @see functionsIn\r\n * @example\r\n *\r\n * function Foo() {\r\n *   this.a = constant('a')\r\n *   this.b = constant('b')\r\n * }\r\n *\r\n * Foo.prototype.c = constant('c')\r\n *\r\n * functions(new Foo)\r\n * // => ['a', 'b']\r\n */",
    "meta": {
        "range": [
            458,
            614
        ],
        "filename": "functions.js",
        "lineno": 22,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\lodash\\lodash-repo",
        "code": {
            "id": "astnode100003076",
            "name": "functions",
            "type": "FunctionDeclaration",
            "paramnames": [
                "object"
            ]
        },
        "vars": {
            "": null
        }
    },
    "description": "Creates an array of function property names from own enumerable properties\rof `object`.",
    "since": "0.1.0",
    "tags": [
        {
            "originalTitle": "category",
            "title": "category",
            "text": "Object",
            "value": "Object"
        }
    ],
    "params": [
        {
            "type": {
                "names": [
                    "Object"
                ]
            },
            "description": "The object to inspect.",
            "name": "object"
        }
    ],
    "returns": [
        {
            "type": {
                "names": [
                    "Array"
                ]
            },
            "description": "Returns the function names."
        }
    ],
    "see": [
        "functionsIn"
    ],
    "examples": [
        "function Foo() {\r  this.a = constant('a')\r  this.b = constant('b')\r}\r\rFoo.prototype.c = constant('c')\r\rfunctions(new Foo)\r// => ['a', 'b']"
    ],
    "name": "functions",
    "longname": "functions",
    "kind": "function",
    "scope": "global",
    "___id": "T000002R000328",
    "___s": true,
    "filepath": "functions.js"
}