Skip to content

getParameterDescriptions

Extract

Import:

import { getParameterDescriptions } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-jsdoc';

Signature:

function getParameterDescriptions(node: JSDocableNode): Map<string, string>

Parameters:

Parameter Type Description
node JSDocableNode The node.

Returns: Map<string, string> — Each parameter’s name mapped to its description.