WebCola
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Variables

timeDay

Days Interval in Local Time; days (e.g., February 7, 2012 at 12:00 AM); typically 24 hours. Days in local time may range from 23 to 25 hours due to daylight saving.

timeFriday

Week Interval for Friday-based weeks in Local Time (e.g., February 10, 2012 at 12:00 AM). 7 days and typically 168 hours.

Weeks in local time may range from 167 to 169 hours due on daylight saving.

timeHour

Hours Interval in Local Time; Hours (e.g., 01:00 AM); 60 minutes.

Note that advancing time by one hour in local time can return the same hour or skip an hour due to daylight saving.

timeMillisecond

timeMillisecond: CountableTimeInterval

Milliseconds Interval in Local Time; the shortest available time unit.

timeMinute

Minutes Interval in Local Time; minutes (e.g., 01:02:00 AM); 60 seconds. Note that ECMAScript ignores leap seconds.

timeMonday

Week Interval for Monday-based weeks in Local Time (e.g., February 6, 2012 at 12:00 AM). 7 days and typically 168 hours.

Weeks in local time may range from 167 to 169 hours due on daylight saving.

timeMonth

Month Interval in Local Time; months (e.g., February 1, 2012 at 12:00 AM); ranges from 28 to 31 days.

timeSaturday

timeSaturday: CountableTimeInterval

Week Interval for Saturday-based weeks in Local Time (e.g., February 11, 2012 at 12:00 AM). 7 days and typically 168 hours.

Weeks in local time may range from 167 to 169 hours due on daylight saving.

timeSecond

Seconds Interval in Local Time; seconds (e.g., 01:23:45.0000 AM); 1,000 milliseconds.

timeSunday

Week Interval for Sunday-based weeks in Local Time (e.g., February 5, 2012 at 12:00 AM). 7 days and typically 168 hours.

Weeks in local time may range from 167 to 169 hours due on daylight saving.

timeThursday

timeThursday: CountableTimeInterval

Week Interval for Thursday-based weeks in Local Time (e.g., February 9, 2012 at 12:00 AM). 7 days and typically 168 hours.

Weeks in local time may range from 167 to 169 hours due on daylight saving.

timeTuesday

Week Interval for Tuesday-based weeks in Local Time (e.g., February 7, 2012 at 12:00 AM). 7 days and typically 168 hours.

Weeks in local time may range from 167 to 169 hours due on daylight saving.

timeWednesday

timeWednesday: CountableTimeInterval

Week Interval for Wednesday-based weeks in Local Time (e.g., February 8, 2012 at 12:00 AM). 7 days and typically 168 hours.

Weeks in local time may range from 167 to 169 hours due on daylight saving.

timeWeek

Week Interval in Local Time. Alias for sunday; 7 days and typically 168 hours.

Weeks in local time may range from 167 to 169 hours due on daylight saving.

timeYear

Year Interval in Local Time; years (e.g., January 1, 2012 at 12:00 AM); ranges from 365 to 366 days.

utcDay

Days Interval in Univarsal Coordinated Time (UTC); days (e.g., February 7, 2012 at 12:00 AM); 24 hours.

utcFriday

Week Interval for Friday-based weeks in Univarsal Coordinated Time (UTC) (e.g., February 10, 2012 at 12:00 AM). 7 days and 168 hours.

utcHour

Hours Interval in Univarsal Coordinated Time (UTC); Hours (e.g., 01:00 AM); 60 minutes.

utcMillisecond

utcMillisecond: CountableTimeInterval

Milliseconds Interval in Univarsal Coordinated Time (UTC); the shortest available time unit.

utcMinute

Minutes Interval in Univarsal Coordinated Time (UTC); minutes (e.g., 01:02:00 AM); 60 seconds. Note that ECMAScript ignores leap seconds.

utcMonday

Week Interval for Monday-based weeks in Univarsal Coordinated Time (UTC) (e.g., February 6, 2012 at 12:00 AM). 7 days and 168 hours.

utcMonth

Month Interval in Univarsal Coordinated Time (UTC); months (e.g., February 1, 2012 at 12:00 AM); ranges from 28 to 31 days.

utcSaturday

Week Interval for Saturday-based weeks in Univarsal Coordinated Time (UTC) (e.g., February 11, 2012 at 12:00 AM). 7 days and 168 hours.

utcSecond

Seconds Interval in Univarsal Coordinated Time (UTC); seconds (e.g., 01:23:45.0000 AM); 1,000 milliseconds.

utcSunday

Week Interval for Sunday-based weeks in Univarsal Coordinated Time (UTC) (e.g., February 5, 2012 at 12:00 AM). 7 days and 168 hours.

utcThursday

Week Interval for Thursday-based weeks in Univarsal Coordinated Time (UTC) (e.g., February 9, 2012 at 12:00 AM). 7 days and 168 hours.

utcTuesday

Week Interval for Tuesday-based weeks in Univarsal Coordinated Time (UTC) (e.g., February 7, 2012 at 12:00 AM). 7 days and 168 hours.

utcWednesday

utcWednesday: CountableTimeInterval

Week Interval for Wednesday-based weeks in Univarsal Coordinated Time (UTC) (e.g., February 8, 2012 at 12:00 AM). 7 days and 168 hours.

utcWeek

Week Interval in Local Time. Alias for sunday; 7 days and 168 hours.

utcYear

Year Interval in Univarsal Coordinated Time (UTC); years (e.g., January 1, 2012 at 12:00 AM); ranges from 365 to 366 days.

Functions

timeDays

  • timeDays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeDay.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

timeFridays

  • timeFridays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeFriday.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

timeHours

  • timeHours(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeHour.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

timeInterval

  • timeInterval(floor: function, offset: function): TimeInterval
  • timeInterval(floor: function, offset: function, count: function, field?: function): CountableTimeInterval
  • Constructs a new custom interval given the specified floor and offset functions.

    The returned custom interval is not countable, i.e. does not exposee the methods "count(..)" and "every(...)".

    Parameters

    • floor: function

      A floor function which takes a single date as an argument and rounds it down to the nearest interval boundary.

        • (date: Date): void
        • Parameters

          • date: Date

          Returns void

    • offset: function

      An offset function which takes a date and an integer step as arguments and advances the specified date by the specified number of boundaries; the step may be positive, negative or zero.

        • (date: Date, step: number): void
        • Parameters

          • date: Date
          • step: number

          Returns void

    Returns TimeInterval

  • Constructs a new custom interval given the specified floor, offset and count functions.

    The returned custom interval is countable and exposes the methods "count(..)" and "every(...)".

    Note: due to an internal optimization, the specified count function must not invoke interval.count on other time intervals.

    Parameters

    • floor: function

      A floor function which takes a single date as an argument and rounds it down to the nearest interval boundary.

        • (date: Date): void
        • Parameters

          • date: Date

          Returns void

    • offset: function

      An offset function which takes a date and an integer step as arguments and advances the specified date by the specified number of boundaries; the step may be positive, negative or zero.

        • (date: Date, step: number): void
        • Parameters

          • date: Date
          • step: number

          Returns void

    • count: function

      A count function which takes a start date and an end date, already floored to the current interval, and returns the number of boundaries between the start (exclusive) and end (inclusive). Note: due to an internal optimization, the specified count function must not invoke interval.count on other time intervals.

        • (start: Date, end: Date): number
        • Parameters

          • start: Date
          • end: Date

          Returns number

    • Optional field: function

      An optional field function which takes a date, already floored to the current interval, and returns the field value of the specified date, corresponding to the number of boundaries between this date (exclusive) and the latest previous parent boundary. For example, for the timeDay interval, this returns the number of days since the start of the month. If a field function is not specified, it defaults to counting the number of interval boundaries since the UNIX epoch of January 1, 1970 UTC. The field function defines the behavior of interval.every.

        • (date: Date): number
        • Parameters

          • date: Date

          Returns number

    Returns CountableTimeInterval

timeMilliseconds

  • timeMilliseconds(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeMillisecond.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

timeMinutes

  • timeMinutes(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeMinute.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

timeMondays

  • timeMondays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeMonday.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

timeMonths

  • timeMonths(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeMonth.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

timeSaturdays

  • timeSaturdays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeSaturday.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

timeSeconds

  • timeSeconds(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeSecond.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

timeSundays

  • timeSundays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeSunday.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

timeThursdays

  • timeThursdays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeThursday.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

timeTuesdays

  • timeTuesdays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeTuesday.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

timeWednesdays

  • timeWednesdays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeWednesday.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

timeWeeks

  • timeWeeks(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeWeek.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

timeYears

  • timeYears(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for timeYear.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcDays

  • utcDays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcDay.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcFridays

  • utcFridays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcFriday.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcHours

  • utcHours(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcHour.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcMilliseconds

  • utcMilliseconds(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcMilliesecond.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcMinutes

  • utcMinutes(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcMinute.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcMondays

  • utcMondays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcMonday.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcMonths

  • utcMonths(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcMonth.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcSaturdays

  • utcSaturdays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcSaturday.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcSeconds

  • utcSeconds(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcSecond.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcSundays

  • utcSundays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcSunday.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcThursdays

  • utcThursdays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcThursday.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcTuesdays

  • utcTuesdays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcTuesday.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcWednesdays

  • utcWednesdays(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcWednesday.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcWeeks

  • utcWeeks(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcWeek.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

utcYears

  • utcYears(start: Date, stop: Date, step?: number): Date[]
  • This is a convenience alias for utcYear.range(...).

    Parameters

    • start: Date

      A start date object for the range.

    • stop: Date

      A stop date object for the range.

    • Optional step: number

      An optional number of steps to apply when calculating the dates in the range.

    Returns Date[]

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