Function: formatCaption()
formatCaption(
month,options?,dateLib?):string
Defined in: src/formatters/formatCaption.ts:15
Formats the caption of the month.
Parameters
| Parameter | Type | Description |
|---|---|---|
month | Date | The date representing the month. |
options? | DateLibOptions | Configuration options for the date library. |
dateLib? | DateLib | The date library to use for formatting. If not provided, a new instance is created. |
Returns
string
The formatted caption as a string.
Default Value
LLLL y (e.g., "November 2022").