Options
All
  • Public
  • Public/Protected
  • All
Menu

@ouracademy/range

Index

Classes

Interfaces

Variables

Functions

Variables

Const emptyRange

emptyRange: Range = range(4, 1)

Use it as a special case pattern.

Const interval

interval: RangeFactory = range

Const max

max: max = Math.max

Const midpoint

midpoint: centre = centre

Const min

min: min = Math.min

Const range

range: RangeFactory = createRangeFactory()

Functions

Const centre

  • centre(aRange: Range): undefined | number

  • Example (es module)

    import { centre, range, emptyRange } from '@ouracademy/range'
centre(range(1, 3)) // 2
centre(range(1, 10)) // 5.5
centre(emptyRange) // undefined (empty intervals doesn't support this concept)

    Parameters

    Returns undefined | number

Const createRangeFactory

Const intersection

Const isBefore

  • isBefore(aRange: Range, otherRange: Range): boolean

  • Example (es module)

    import { range, isBefore } from '@ouracademy/range'
isBefore(range(0, 2), range(3, 7)) // true
isBefore(range(0, 5), range(3, 7)) // false

    Parameters

    Returns boolean

Const overlaps

  • overlaps(aRange: Range, otherRange: Range): boolean

Generated using TypeDoc