0
Fork 0
mirror of https://github.com/TanStack/time.git synced 2026-11-16 19:09:47 +00:00
time/docs/reference/interfaces/CalendarFeature.md
2026-08-22 23:22:16 +00:00

1.7 KiB

id title
CalendarFeature CalendarFeature

Interface: CalendarFeature<TResource, TEvent, TModuleApi, TApi, TName, TPeers>

Defined in: calendar/features/types.ts:70

Type Parameters

TResource

TResource extends Resource

TEvent

TEvent extends Event<TResource>

TModuleApi

TModuleApi = object

TApi

TApi = object

TName

TName extends string = string

TPeers

TPeers = object

Properties

api()?

optional api: (host, module, peers) => TApi;

Defined in: calendar/features/types.ts:81

Parameters

host

CalendarHost<TResource, TEvent>

module

TModuleApi

peers

TPeers

Returns

TApi


module()?

optional module: (ctx) => Module<TEvent & KernelEvent, TModuleApi>;

Defined in: calendar/features/types.ts:80

Parameters

ctx

FeatureModuleCtx<TResource>

Returns

Module<TEvent & KernelEvent, TModuleApi>


name

name: TName;

Defined in: calendar/features/types.ts:78


requires?

optional requires: readonly string[];

Defined in: calendar/features/types.ts:79