mirror of
https://github.com/acamarata/dayjs-hijri-plus.git
synced 2026-07-01 11:14:26 +00:00
033ca47576
Add typedoc and typedoc-plugin-markdown as devDependencies. Add typedoc.json config targeting src/index.ts with markdown output to .github/wiki/api. Add docs script to package.json. Generate initial API reference pages. Part of T-E8-03 — TypeDoc automation for all 12 JS/TS packages.
33 lines
719 B
Markdown
33 lines
719 B
Markdown
[**dayjs-hijri-plus v1.0.1**](../README.md)
|
|
|
|
***
|
|
|
|
[dayjs-hijri-plus](../README.md) / getCalendar
|
|
|
|
# Function: getCalendar()
|
|
|
|
> **getCalendar**(`name`): [`CalendarEngine`](../interfaces/CalendarEngine.md)
|
|
|
|
Defined in: node\_modules/.pnpm/hijri-core@1.0.0/node\_modules/hijri-core/dist/index.d.mts:26
|
|
|
|
Re-exported registry API from hijri-core.
|
|
Register, retrieve, or list custom calendar engines without adding
|
|
hijri-core as a direct dependency.
|
|
|
|
## Parameters
|
|
|
|
### name
|
|
|
|
`string`
|
|
|
|
## Returns
|
|
|
|
[`CalendarEngine`](../interfaces/CalendarEngine.md)
|
|
|
|
## Example
|
|
|
|
```ts
|
|
import { registerCalendar, listCalendars } from 'dayjs-hijri-plus';
|
|
registerCalendar('my-cal', myEngine);
|
|
listCalendars(); // ['uaq', 'fcna', 'my-cal']
|
|
```
|