Vizel API / core/src / VizelRelativeTimeTickerOptions

Interface: VizelRelativeTimeTickerOptions

Defined in: packages/core/src/controllers/relativeTimeTicker.ts:7

Options for createVizelRelativeTimeTicker.

Properties

getDate

getDate: () => Date | null | undefined;

Defined in: packages/core/src/controllers/relativeTimeTicker.ts:9

Returns the reference date. null/undefined is rendered as an empty string.

Returns

Date | null | undefined

---

getLocale?

optional getLocale?: () => VizelLocale | undefined;

Defined in: packages/core/src/controllers/relativeTimeTicker.ts:11

Returns the active locale (optional, called per tick).

Returns

VizelLocale | undefined

---

intervalMs?

optional intervalMs?: number;

Defined in: packages/core/src/controllers/relativeTimeTicker.ts:13

Tick interval in milliseconds (default: 10000).

---

onTick

onTick: (text) => void;

Defined in: packages/core/src/controllers/relativeTimeTicker.ts:15

Called with the formatted string on every tick (and once synchronously).

Parameters

Parameter	Type
text	string

Returns

void