Skip to content

getRemarks

Extract

text from JSDoc

Import:

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

Signature:

function getRemarks(node: JSDocableNode): string

Parameters:

Parameter Type Description
node JSDocableNode The node.

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