Skip to content

getDescription

Extracts the JSDoc description of a node.

Import:

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

Signature:

function getDescription(node: JSDocableNode): string

Parameters:

Parameter Type Description
node JSDocableNode The node.

Returns: string — The description, or an empty string.