ScheduleIntervals overview

Added in v2.0.0

Table of contents

• constructors
  • empty
  • fromIterable
  • make
• getters
  • end
  • isNonEmpty
  • start
• models
  • Intervals (interface)
• ordering
  • lessThan
  • max
• symbols
  • IntervalsTypeId
  • IntervalsTypeId (type alias)
• utils
  • intersect
  • union

constructors

empty

Constructs an empty list of Intervals.

Signature

export declare const empty: Intervals

Added in v2.0.0

fromIterable

Creates Intervals from the specified Iterable<Interval>.

Signature

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

Added in v2.0.0

make

Creates a new Intervals from a List of Intervals.

Signature

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

Added in v2.0.0

getters

end

The end of the latest interval in the specified Intervals.

Signature

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

Added in v2.0.0

isNonEmpty

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

Signature

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

Added in v2.0.0

start

The start of the earliest interval in the specified Intervals.

Signature

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

Added in 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>
}

Added in v2.0.0

ordering

lessThan

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

Signature

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

Added in v2.0.0

max

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

Signature

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

Added in v2.0.0

symbols

IntervalsTypeId

Signature

export declare const IntervalsTypeId: typeof IntervalsTypeId

Added in v2.0.0

IntervalsTypeId (type alias)

Signature

export type IntervalsTypeId = typeof IntervalsTypeId

Added in v2.0.0

utils

intersect

Produces the intersection of this Intervals and that Intervals.

Signature

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

Added in v2.0.0

union

Computes the union of this Intervals and that Intervals

Signature

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

Added in v2.0.0