Function: recordNameOf()

function recordNameOf(commentText, configuration?): string | undefined;

Defined in: packages/core/src/grammar.ts:348

Whether a comment's text opens a record — i.e. carries a record tag. Uses the configuration's record tags when given, else the default RECORD_TAGS.

Parameters

commentText

string

The comment body.

configuration?

CssDocConfiguration

The active configuration (optional).

Returns

string | undefined

The record name, or undefined.