Skip to main content

fitsSchedule

Stentor API Reference

Stentor API Reference / stentor-time/src / fitsSchedule

Function: fitsSchedule()

fitsSchedule(start, startFormat, duration, durationFormat, timeZone?): boolean

Defined in: packages/stentor-time/src/TimeConditionalCheck.ts:61

Is the current time within the provided schedule.

Parameters​

start​

string

Start date string

startFormat​

string

Format of the start date string

duration​

number

Duration amount

durationFormat​

DurationFormat

Format of the duration

timeZone?​

string

Optional time zone

Returns​

boolean