Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RangeInclusiveExpr

Hierarchy

  • RangeBase
    • RangeInclusiveExpr

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • throws

    Will throw RangeError if one of the bounds is NaN or +-Infinity.

    Parameters

    • start: number

      The lower bound of the range (inclusive).

    • end: number

      The upper bound of the range (inclusive).

    Returns RangeInclusiveExpr

Properties

Private #end

#end: number

Private #inclusive

#inclusive: boolean

Private #start

#start: number

[iterator]

[iterator]: () => Generator<number, void, number> = ...

Type declaration

    • (): Generator<number, void, number>

    • Returns Generator<number, void, number>

Accessors

end

  • get end(): number

  • Returns number

start

  • get start(): number

  • Returns number

Methods

clone

  • Returns RangeInclusiveExpr

contains

  • contains(item: number): boolean

  • Returns true if item is contained in the range.

    throws

    Will throw RangeError if one of the bounds is NaN.

    Parameters

    • item: number

      The searched value

    Returns boolean

extractSlice

  • extractSlice<T, SR>(source: T & { slice: any }): SR

  • Type parameters

    • T

    • SR

    Parameters

    • source: T & { slice: any }

    Returns SR

getBounds

  • getBounds(): [number, number]

  • Returns the bounds of a Range

    Returns [number, number]

isEmpty

  • isEmpty(): boolean

  • Returns true if the range contains no items.

    Returns boolean

isExhaustive

  • isExhaustive(): boolean

  • Returns true if the Range is exhaustive.

    Returns boolean

isInclusive

  • isInclusive(): boolean

  • Returns true if the Range includes the end.

    Returns boolean

toString

  • toString(): string

  • Returns string

Generated using TypeDoc