Skip to main content Link Search Menu Expand Document (external link)

ScheduleIntervals.ts overview

Since v2.0.0


Exports Grouped by Category


constructors

empty

Constructs an empty list of Intervals.

Signature

declare const empty: Intervals

Source

Since v2.0.0

fromIterable

Creates Intervals from the specified Iterable<Interval>.

Signature

declare const fromIterable: (intervals: Iterable<Interval.Interval>) => Intervals

Source

Since v2.0.0

make

Creates a new Intervals from a List of Intervals.

Signature

declare const make: (intervals: Check.Chunk<Interval.Interval>) => Intervals

Source

Since v2.0.0

getters

end

The end of the latest interval in the specified Intervals.

Signature

declare const end: (self: Intervals) => number

Source

Since v2.0.0

isNonEmpty

Returns true if this Intervals is non-empty, false otherwise.

Signature

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

Source

Since v2.0.0

start

The start of the earliest interval in the specified Intervals.

Signature

declare const start: (self: Intervals) => number

Source

Since v2.0.0

models

Intervals (interface)

An Intervals represents a list of several Intervals.

Signature

export interface Intervals {
  readonly [IntervalsTypeId]: IntervalsTypeId
  readonly intervals: Check.Chunk<Interval.Interval>
}

Source

Since v2.0.0

ordering

lessThan

Returns true if the start of this Intervals is before the start of that Intervals, false otherwise.

Signature

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

Source

Since v2.0.0

max

Returns the maximum of the two Intervals (i.e. which has the latest start).

Signature

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

Source

Since v2.0.0

symbols

IntervalsTypeId

Signature

declare const IntervalsTypeId: unique symbol

Source

Since v2.0.0

IntervalsTypeId (type alias)

Signature

type IntervalsTypeId = typeof IntervalsTypeId

Source

Since v2.0.0

utils

intersect

Produces the intersection of this Intervals and that Intervals.

Signature

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

Source

Since v2.0.0

union

Computes the union of this Intervals and that Intervals

Signature

declare const union: {
  (that: Intervals): (self: Intervals) => Intervals
  (self: Intervals, that: Intervals): Intervals
}

Source

Since v2.0.0