dayspan
Options
All
  • Public
  • Public/Protected
  • All
Menu

Input given by a user which describes an event schedule.

Type parameters

  • M

    The type of metadata stored in the schedule.

Hierarchy

  • ScheduleInput

Index

Properties

Methods

Properties

Optional cancel

cancel: (string | number | Day)[]

An array of days or identifiers which should be canceled in the schedule.

see

Schedule.cancel

Optional day

day: FrequencyValue
see

Schedule.day

Optional dayOfMonth

dayOfMonth: FrequencyValue
see

Schedule.dayOfMonth

Optional dayOfWeek

dayOfWeek: FrequencyValue
see

Schedule.dayOfWeek

Optional dayOfYear

dayOfYear: FrequencyValue
see

Schedule.dayOfYear

Optional duration

duration: number
see

Schedule.duration

Optional durationUnit

durationUnit: string
see

Schedule.durationUnit

Optional end

end: DayInput
see

Schedule.end

Optional exclude

exclude: (string | number | Day)[]

An array of days or identifiers which should be excluded from the schedule.

see

Schedule.exclude

Optional fullWeekOfMonth

fullWeekOfMonth: FrequencyValue
see

Schedule.fullWeekOfMonth

Optional fullWeekOfYear

fullWeekOfYear: FrequencyValue
see

Schedule.fullWeekOfYear

Optional include

include: (string | number | Day)[]

An array of days or identifiers which should be included in the schedule.

see

Schedule.include

Optional lastDayOfMonth

lastDayOfMonth: FrequencyValue
see

Schedule.lastDayOfMonth

Optional lastFullWeekOfMonth

lastFullWeekOfMonth: FrequencyValue
see

Schedule.lastFullWeekOfMonth

Optional lastFullWeekOfYear

lastFullWeekOfYear: FrequencyValue
see

Schedule.lastFullWeekOfYear

Optional lastWeekspanOfMonth

lastWeekspanOfMonth: FrequencyValue
see

Schedule.lastWeekspanOfMonth

Optional lastWeekspanOfYear

lastWeekspanOfYear: FrequencyValue
see

Schedule.lastWeekspanOfYear

Optional maxOccurrences

maxOccurrences: number
see

Schedule.maxOccurrences

Optional meta

meta: object
see

Schedule.meta

Type declaration

  • [identifier: string]: M

Optional month

month: FrequencyValue
see

Schedule.month

Optional on

on: DayInput

A shortcut to setting the Schedule.start, Schedule.end, Schedule.year, Schedule.month, and Schedule.dayOfMonth.

Optional quarter

quarter: FrequencyValue
see

Schedule.quarter

Optional start

start: DayInput
see

Schedule.start

Optional times

times: TimeInput[]
see

Schedule.times

Optional week

week: FrequencyValue
see

Schedule.week

Optional weekOfMonth

weekOfMonth: FrequencyValue
see

Schedule.weekOfMonth

Optional weekOfYear

weekOfYear: FrequencyValue
see

Schedule.weekOfYear

Optional weekspanOfMonth

weekspanOfMonth: FrequencyValue
see

Schedule.weekspanOfMonth

Optional weekspanOfYear

weekspanOfYear: FrequencyValue
see

Schedule.weekspanOfYear

Optional year

year: FrequencyValue
see

Schedule.year

Methods

Optional parseMeta

  • parseMeta(input: any): M

  • The function to parse metadata with.

    Parameters

    • input: any

    Returns M

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc