{"id":17222805,"url":"https://github.com/onury/jsdoc-x","last_synced_at":"2025-04-14T00:17:56.067Z","repository":{"id":57284269,"uuid":"54240390","full_name":"onury/jsdoc-x","owner":"onury","description":"Parser for outputting a Javascript object from documented code via JSDoc's explain (-X) command.","archived":false,"fork":false,"pushed_at":"2020-01-22T01:30:05.000Z","size":176,"stargazers_count":14,"open_issues_count":4,"forks_count":7,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T14:21:17.430Z","etag":null,"topics":["documentation","javascript","jsdoc","parse"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/onury.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-03-19T01:04:29.000Z","updated_at":"2024-09-06T16:44:48.000Z","dependencies_parsed_at":"2022-09-07T20:12:06.699Z","dependency_job_id":null,"html_url":"https://github.com/onury/jsdoc-x","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onury%2Fjsdoc-x","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onury%2Fjsdoc-x/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onury%2Fjsdoc-x/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onury%2Fjsdoc-x/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/onury","download_url":"https://codeload.github.com/onury/jsdoc-x/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248480446,"owners_count":21110939,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","javascript","jsdoc","parse"],"created_at":"2024-10-15T04:06:23.832Z","updated_at":"2025-04-14T00:17:56.022Z","avatar_url":"https://github.com/onury.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jsdoc-x\n\n[![build-status](https://img.shields.io/travis/onury/jsdoc-x.svg?branch=master)](https://travis-ci.org/onury/jsdoc-x)\n[![npm](http://img.shields.io/npm/v/jsdoc-x.svg)](https://www.npmjs.com/package/jsdoc-x)\n[![release](https://img.shields.io/github/release/onury/jsdoc-x.svg)](https://github.com/onury/jsdoc-x/releases)\n[![license](http://img.shields.io/npm/l/jsdoc-x.svg)](https://github.com/onury/jsdoc-x/blob/master/LICENSE)\n[![downloads](https://img.shields.io/npm/dt/jsdoc-x.svg)](https://www.npmjs.com/package/jsdoc-x)\n[![dependencies](https://david-dm.org/onury/jsdoc-x.svg)](https://david-dm.org/onury/jsdoc-x)\n[![maintained](https://img.shields.io/maintenance/yes/2020.svg)](https://github.com/onury/jsdoc-x/graphs/commit-activity)  \n\n\u003e © 2020, Onur Yıldırım ([@onury](https://github.com/onury)). MIT License.\n\nParser for outputting a Javascript object from documented code via JSDoc's explain (`-X`) command.  \n\n**Install via NPM**:\n```shell\nnpm i jsdoc-x\n```\n\n## Usage:\n\n```js\nconst jsdocx = require('jsdoc-x');\ntry {\n    const docs = await jsdocx.parse('./src/**/*.js');\n    console.log(docs);\n} catch (err) {\n    console.log(err.stack);\n}\n```\n_(If you like pain, `.parse()` method also supports a callback, instead of promises.)_\n\n\nSee an **output example** [here](https://github.com/onury/jsdoc-x/blob/master/test/output/docs.json).\n\n## `jsdocx.parse(options[, callback])`  \n\nExecutes the `jsdoc -X` command and parses the output into a Javascript object/array; with the specified options.  \n\n\u003ctable\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003eParam\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cb\u003eType\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cb\u003eDescription\u003c/b\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eoptions\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eObject|Array|String\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003eRequired. Either an options object or one or more source files to be processed. See details below.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003ecallback\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eFunction\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Callback function to be executed in the following signature: `function (err, array) { ... }`. Omit this callback to return a `Promise`. Default: \u003ccode\u003eundefined\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\n\n### `options`\n`Object|Array|String` - Parse options.\n\n\u003ctable\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003eOption\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cb\u003eType\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cb\u003eDescription\u003c/b\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003efiles\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString|Array\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Required (if \u003ccode\u003esource\u003c/code\u003e is not set). One or more file/directory paths to be processed. This also accepts a \u003ca href=\"https://github.com/isaacs/node-glob\"\u003eGlob\u003c/a\u003e string or array of globs. e.g. \u003ccode\u003e./src/\u0026#x2A;\u0026#x2A;/\u0026#x2A;.js\u003c/code\u003e will produce an array of all \u003ccode\u003e.js\u003c/code\u003e files under \u003c/code\u003e./src\u003c/code\u003e directory and sub-directories. Default: \u003ccode\u003eundefined\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003esource\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Required (if \u003ccode\u003efiles\u003c/code\u003e is not set). Documented source code to be processed. If \u003ccode\u003efiles\u003c/code\u003e is also set, this will be ignored. Default: \u003ccode\u003eundefined\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003econfig\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eObject\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Pass a configuration object to the underlying JSDoc core. This will bypass all parser options. Default:  \u003ccode\u003e{}\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eencoding\u003c/code\u003e\u003cb\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003eEncoding to be used when reading source files. Default: \u003ccode\u003e\"utf8\"\u003c/code\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003erecurse\u003c/code\u003e\u003cb\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to recurse into subdirectories when scanning for source files. Default: \u003ccode\u003efalse\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003epedantic\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to treat errors as fatal errors, and treat warnings as errors. Default: \u003ccode\u003efalse\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eaccess\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString|Array\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies which symbols to be processed with the given access property. Possible values: \u003ccode\u003e\"private\"\u003c/code\u003e, \u003ccode\u003e\"protected\"\u003c/code\u003e, \u003ccode\u003e\"public\"\u003c/code\u003e or \u003ccode\u003e\"all\"\u003c/code\u003e (for all access levels). By default, all except private symbols are processed. Note that, if access is not set for a documented symbol, it will still be included, regardless of this option. Default: \u003ccode\u003eundefined\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eprivate\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003eShorthand for enabling documentation for \u003ccode\u003eprivate\u003c/code\u003e access symbols. Default: \u003ccode\u003efalse\u003c/code\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003epackage\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            The path to the \u003ccode\u003epackage.json\u003c/code\u003e file that contains the project name, version, and other details. If set to \u003ccode\u003etrue\u003c/code\u003e instead of a path string, the first \u003ccode\u003epackage.json\u003c/code\u003e file found in the source paths. Default: \u003ccode\u003eundefined\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003emodule\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to include \u003ccode\u003emodule.exports\u003c/code\u003e symbols. Default: \u003ccode\u003etrue\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eundocumented\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to include undocumented symbols. Default: \u003ccode\u003etrue\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eundescribed\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to include symbols without a description. Default: \u003ccode\u003etrue\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eignored\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to include symbols marked with \u003ccode\u003e@ignore\u003c/code\u003e tag. Default: \u003ccode\u003etrue\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eallowUnknownTags\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to allow unrecognized tags.\n            If set to \u003ccode\u003efalse\u003c/code\u003e parsing will fail on unknown tags. Default: \u003ccode\u003etrue\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003edictionaries\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eArray\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Indicates the dictionaries to be used. By default, both standard JSDoc tags and Closure Compiler tags are enabled. Default: \u003ccode\u003e[\"jsdoc\", \"closure\"]\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eincludePattern\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            String pattern for defining sources to be included. By default, only files ending in \".js\", \".jsdoc\", and \".jsx\" will be processed. Default: \u003ccode\u003e\".+\\\\.js(doc|x)?$\"\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eexcludePattern\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            String pattern for defining sources to be ignored. By default, any file starting with an underscore or in a directory starting with an underscore will be ignored. Default: \u003ccode\u003e\"(^|\\\\/|\\\\\\\\)_\"\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eplugins\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eArray\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Defines the JSDoc plugins to be used.\n            See \u003ca href=\"http://usejsdoc.org/about-plugins.html\"\u003ethis guide\u003c/a\u003e on JSDoc plugins. Default: \u003ccode\u003e[]\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003erelativePath\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            When set, all \u003ccode\u003esymbol.meta.path\u003c/code\u003e values will be relative to this path. Default: \u003ccode\u003eundefined\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003epredicate\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eFunction|string\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Alias: \u003ccode\u003efilter\u003c/code\u003e. This is used to filter the parsed documentation output array. If a \u003ccode\u003eFunction\u003c/code\u003e is passed; it's invoked for each included \u003ccode\u003esymbol\u003c/code\u003e. e.g. \u003ccode\u003efunction (symbol) { return symbol; }\u003c/code\u003e Returning a falsy value will remove the symbol from the output. Returning \u003ccode\u003etrue\u003c/code\u003e will keep the original symbol. To keep the symbol and alter its contents, simply return an altered symbol object. If a RegExp string is passed, it's executed on the symbol's long name. Default: \u003ccode\u003eundefined\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003ehierarchy\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to arrange symbols by their hierarchy. This will find and move symbols that have a \u003ccode\u003ememberof\u003c/code\u003e property to a \u003ccode\u003e$members\u003c/code\u003e property of their corresponding owners. Also the constructor symbol will be moved to a \u003ccode\u003e$constructor\u003c/code\u003e property of the \u003ccode\u003eClassDeclaration\u003c/code\u003e symbol; if any. Default: \u003ccode\u003efalse\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003esort\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean|String\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to sort the documentation symbols. For alphabetic sort, set to \u003ccode\u003etrue\u003c/code\u003e or \u003ccode\u003e\"alphabetic\"\u003c/code\u003e. To group-sort set to \u003ccode\u003e\"grouped\"\u003c/code\u003e. \u003ci\u003e(Group sorting is done in the following order: by memberof, by scope, by access type, by kind, alphabetic.)\u003c/i\u003e To sort by only \u003ccode\u003e\"scope\"\u003c/code\u003e or \u003ccode\u003e\"access\"\u003c/code\u003e or \u003ccode\u003e\"kind\"\u003c/code\u003e, set to corresponding string. \u003ci\u003e(Sorting by kind is done in the following order: constant, package/module, namespace, class, constructor, method, property, enum, typedef, event, interface, mixin, external, other members.)\u003c/i\u003e Set to \u003ccode\u003efalse\u003c/code\u003e to disable. Default: \u003ccode\u003efalse\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eoutput\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString|Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Path for a JSON file to be created, containing the output documentation array. Or you can set this to an object for extra options. Default: \u003ccode\u003eundefined\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e↳\u003ccode\u003eoutput.\u003cb\u003epath\u003c/b\u003e\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003ePath for a JSON file to be created. Default: \u003ccode\u003eundefined\u003c/code\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e↳\u003ccode\u003eoutput.\u003cb\u003eindent\u003c/b\u003e\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean|Number\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003eNumber of spaces for indentation. If set to \u003ccode\u003etrue\u003c/code\u003e, 2 spaces will be used. Default: \u003ccode\u003efalse\u003c/code\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e↳\u003ccode\u003eoutput.\u003cb\u003eforce\u003c/b\u003e\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Whether to create parent directories if they don't exist. Default: \u003ccode\u003efalse\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003edebug\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to include extra information within thrown error messages. Default: \u003ccode\u003etrue\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\n\n\n## `jsdocx.filter(docs[, options][, predicate])`  \n\nFilters the given documentation output array. This is useful if you have an already parsed documentation output.  \n\n\u003ctable\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003eParam\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cb\u003eType\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cb\u003eDescription\u003c/b\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003edocs\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eArray\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003eRequired. Documentation output array.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eoptions\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eObject\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003eFilter options. See details below. Default: \u003ccode\u003eundefined\u003c/code\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003epredicate\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eFunction\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            The function invoked per iteration. Returning a falsy value will remove the symbol from the output. Returning \u003ccode\u003etrue\u003c/code\u003e will keep the original symbol. To keep the symbol and alter its contents, simply return an altered symbol object. Default: \u003ccode\u003eundefined\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\n\n### `options`\n`Object` - Filter options.\n\n\u003ctable\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003eOption\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cb\u003eType\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cb\u003eDescription\u003c/b\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eaccess\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString|Array\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies which symbols to be processed with the given access property. Possible values: \u003ccode\u003e\"private\"\u003c/code\u003e, \u003ccode\u003e\"protected\"\u003c/code\u003e, \u003ccode\u003e\"public\"\u003c/code\u003e or \u003ccode\u003e\"all\"\u003c/code\u003e (for all access levels). By default, all except private symbols are processed. Note that, if access is not set for a documented symbol, it will still be included, regardless of this option. Default: \u003ccode\u003eundefined\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003epackage\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            The path to the \u003ccode\u003epackage.json\u003c/code\u003e file that contains the project name, version, and other details. If set to \u003ccode\u003etrue\u003c/code\u003e instead of a path string, the first \u003ccode\u003epackage.json\u003c/code\u003e file found in the source paths. Default: \u003ccode\u003eundefined\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003emodule\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to include \u003ccode\u003emodule.exports\u003c/code\u003e symbols. Default: \u003ccode\u003etrue\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eundocumented\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to include undocumented symbols. Default: \u003ccode\u003etrue\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eundescribed\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to include symbols without a description. Default: \u003ccode\u003etrue\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003erelativePath\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            When set, all \u003ccode\u003esymbol.meta.path\u003c/code\u003e values will be relative to this path. Default: \u003ccode\u003eundefined\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003ehierarchy\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to arrange symbols by their hierarchy. This will find and move symbols that have a \u003ccode\u003ememberof\u003c/code\u003e property to a \u003ccode\u003e$members\u003c/code\u003e property of their corresponding owners. Also the constructor symbol will be moved to a \u003ccode\u003e$constructor\u003c/code\u003e property of the \u003ccode\u003eClassDeclaration\u003c/code\u003e symbol; if any. Default: \u003ccode\u003efalse\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003esort\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean|String\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Specifies whether to sort the documentation symbols. For alphabetic sort, set to \u003ccode\u003etrue\u003c/code\u003e or \u003ccode\u003e\"alphabetic\"\u003c/code\u003e. To additionally group by scope (static/instance) set to \u003ccode\u003e\"grouped\"\u003c/code\u003e. Set to \u003ccode\u003efalse\u003c/code\u003e to disable. Default: \u003ccode\u003efalse\u003c/code\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\n\n## `jsdocx.utils`  \n\nUtilities for documentation output and symbols.\n\n\u003ctable\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003eMethod\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cb\u003eParams\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cb\u003eReturns\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003cb\u003eDescription\u003c/b\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003egetFullName(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Alias: \u003ccode\u003egetLongName()\u003c/code\u003e. Gets the full name of the given symbol.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003egetCodeName(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Gets the code name of the given symbol.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003egetName(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eString\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Gets the (short) code-name of the given symbol.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003egetSymbolByName(docs, name)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            \u003ccode\u003edocs:Array\u003c/code\u003e\n            \u003ccode\u003ename:String\u003c/code\u003e\n        \u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Gets the first matching symbol by the given name.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003egetSymbolNames(docs, sorter)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            \u003ccode\u003edocs:Array\u003c/code\u003e\n            \u003ccode\u003esorter:Function|String\u003c/code\u003e\n        \u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eArray\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Builds and gets a flat array of symbol names from the given jsdoc-x parsed output.\n            Pass a comparer function for \u003ccode\u003esorter\u003c/code\u003e or a pre-defined string \u003ccode\u003e\"alphabetic\"\u003c/code\u003e or \u003ccode\u003e\"grouped\"\u003c/code\u003e.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003egetKind(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eNumber\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Gets the kind of the symbol. This is not the same as \u003ccode\u003esymbol.kind\u003c/code\u003e. i.e. JSDoc generates a constructor's kind as \u003ccode\u003e\"class\"\u003c/code\u003e. This will return \u003ccode\u003e\"constructor\"\u003c/code\u003e. Enumeration objects are returned as \u003ccode\u003e\"enum\"\u003c/code\u003e. Function members are returned as \u003ccode\u003e\"method\"\u003c/code\u003e, non-function members are returned as \u003ccode\u003e\"property\"\u003c/code\u003e (including getters/setters)...\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003egetLevels(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object|String\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eNumber\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Gets the number of levels for the given symbol or name. e.g. \u003ccode\u003emylib.prop\u003c/code\u003e has 2 levels.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003egetParentName(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object|String\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eNumber\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Gets the parent symbol name from the given symbol's name. Note that, this will return the parent name even if the parent symbol does not exist in the documentation. If there is no parent, returns \u003ccode\u003e\"\"\u003c/code\u003e (empty string).\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003egetParent(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object|String\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eNumber\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Gets the parent symbol object from the given symbol object or symbol's name.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003ehasDescription(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol has description.\n        \u003c/td\u003e\n    \u003c/tr\u003e    \n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisCallback(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is a callback definition.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisClass(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is a class.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisConstant(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is a marked as a constant.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisConstructor(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is a constructor.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisDeprecated(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is marked with \u003ccode\u003e@deprecated\u003c/code\u003e.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisEnum(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is an enumeration.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisEvent(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is an event.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisExternal(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is defined outside of the current package.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisGenerator(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is a generator function.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisGlobal(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol has global scope.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisIgnored(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is marked with \u003ccode\u003e@ignore\u003c/code\u003e.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisInner(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol has an inner scope.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisInstanceMember(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is an instance member.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisInstanceMethod(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is an instance method.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisInstanceProperty(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is an instance property.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisMixin(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is marked as a mixin (is intended to be added to other objects).\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisNamespace(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is a namespace.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisProperty(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is a property.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisReadOnly(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is read-only.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisMethod(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is a method.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisStaticMember(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is a static member.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisStaticMethod(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is a static method.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisStaticProperty(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is a static property.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisTypeDef(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Alias: \u003ccode\u003eisCustomType()\u003c/code\u003e. Checks whether the given symbol is a custom type definition.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisInterface(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is marked as an interface that other symbols can implement.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisPublic(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol has \u003ccode\u003epublic\u003c/code\u003e access.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisPrivate(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol has \u003ccode\u003eprivate\u003c/code\u003e access.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisPackagePrivate(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol has \u003ccode\u003epackage\u003c/code\u003e private access; indicating that the symbol is available only to code in the same directory as the source file for this symbol.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisProtected(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol has \u003ccode\u003eprotected\u003c/code\u003e access.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003eisUndocumented(symbol)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003eBoolean\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Checks whether the given symbol is undocumented. This checks if the symbol has any comments.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003cb\u003e\u003ccode\u003enotate(symbol, notation)\u003c/code\u003e\u003c/b\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003esymbol:Object\u003c/code\u003e\u003cbr /\u003e\u003ccode\u003enotation:String\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003e\u0026#x2A;\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\n            Gets the value by the given object notation.\n        \u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\n\n---\n\n### Change-log:\n\nSee [CHANGELOG.md](CHANGELOG.md).\n\n\n[onury]:https://github.com/onury\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonury%2Fjsdoc-x","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonury%2Fjsdoc-x","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonury%2Fjsdoc-x/lists"}