ScheduleInterval.ts overview

Since v2.0.0

Exports Grouped by Category

• constructors
  • after
  • before
  • empty
  • make
• getters
  • size
• models
  • Interval (interface)
• ordering
  • intersect
  • isEmpty
  • isNonEmpty
  • lessThan
  • max
  • min
• symbols
  • IntervalTypeId
  • IntervalTypeId (type alias)
• utils
  • union

constructors

after

Construct an Interval that includes all time equal to and after the specified start time.

Signature

declare const after: (startMilliseconds: number) => Interval

Source

Since v2.0.0

before

Construct an Interval that includes all time equal to and before the specified end time.

Signature

declare const before: (endMilliseconds: number) => Interval

Source

Since v2.0.0

empty

An Interval of zero-width.

Signature

declare const empty: Interval

Source

Since v2.0.0

make

Constructs a new interval from the two specified endpoints. If the start endpoint greater than the end endpoint, then a zero size interval will be returned.

Signature

declare const make: (startMillis: number, endMillis: number) => Interval

Source

Since v2.0.0

getters

size

Calculates the size of the Interval as the Duration from the start of the interval to the end of the interval.

Signature

declare const size: (self: Interval) => Duration.Duration

Source

Since v2.0.0

models

Interval (interface)

An Interval represents an interval of time. Intervals can encompass all time, or no time at all.

Signature

export interface Interval {
  readonly [IntervalTypeId]: IntervalTypeId
  readonly startMillis: number
  readonly endMillis: number
}

Source

Since v2.0.0

ordering

intersect

Computes a new Interval which is the intersection of this Interval and that Interval.

Signature

declare const intersect: { (that: Interval): (self: Interval) => Interval; (self: Interval, that: Interval): Interval }

Source

Since v2.0.0

isEmpty

Returns true if the specified Interval is empty, false otherwise.

Signature

declare const isEmpty: (self: Interval) => boolean

Source

Since v2.0.0

isNonEmpty

Returns true if the specified Interval is non-empty, false otherwise.

Signature

declare const isNonEmpty: (self: Interval) => boolean

Source

Since v2.0.0

lessThan

Returns true if this Interval is less than that interval, false otherwise.

Signature

declare const lessThan: { (that: Interval): (self: Interval) => boolean; (self: Interval, that: Interval): boolean }

Source

Since v2.0.0

max

Returns the maximum of two Intervals.

Signature

declare const max: { (that: Interval): (self: Interval) => Interval; (self: Interval, that: Interval): Interval }

Source

Since v2.0.0

min

Returns the minimum of two Intervals.

Signature

declare const min: { (that: Interval): (self: Interval) => Interval; (self: Interval, that: Interval): Interval }

Source

Since v2.0.0

symbols

IntervalTypeId

Signature

declare const IntervalTypeId: unique symbol

Source

Since v2.0.0

IntervalTypeId (type alias)

Signature

type IntervalTypeId = typeof IntervalTypeId

Source

Since v2.0.0

utils

union

Computes a new Interval which is the union of this Interval and that Interval as a Some, otherwise returns None if the two intervals cannot form a union.

Signature

declare const union: {
  (that: Interval): (self: Interval) => Option.Option<Interval>
  (self: Interval, that: Interval): Option.Option<Interval>
}

Source

Since v2.0.0