Skip to content
ts
import { Clock } from '@trail-run/core/time/clock';

Class: Clock

Defined in: src/time/clock.ts:15

A reactive clock that updates every minute to provide the current local time, as well as derived values like the current week number.

Likely you want to use the singleton clock instance exported from this module rather than instantiating your own.

Constructors

Constructor

ts
new Clock(): Clock;

Defined in: src/time/clock.ts:23

Returns

Clock

Properties

firstDayOfWeek

ts
firstDayOfWeek: "monday" | "sunday" = 'monday';

Defined in: src/time/clock.ts:21


now

ts
now: Date;

Defined in: src/time/clock.ts:20

Date instance for the current time, accurate to within one minute.

daysRemainingInWeek

Get Signature

ts
get daysRemainingInWeek(): number;

Defined in: src/time/clock.ts:67

Returns

number


nextWeek

Get Signature

ts
get nextWeek(): object;

Defined in: src/time/clock.ts:50

Returns

object

day
ts
day: "monday" | "sunday";
today
ts
today: Date = nextWeekDate;
weekNo
ts
weekNo: number;
year
ts
year: number;

today

Get Signature

ts
get today(): object;

Defined in: src/time/clock.ts:35

Get today's date, year, and week number

Returns

object

day
ts
day: "monday" | "sunday";
today
ts
today: Date;
weekNo
ts
weekNo: number;
year
ts
year: number;

Released under the MIT License.