Range
PackagesGitHub
Draft
Draft
  • Introduction
  • ❤ Benefits
  • General concepts
  • Getting started
    • Skeleton
    • Installation
      • npm
    • Public API
    • Basic concepts
  • Greater {}
    • Overview
    • Generic type variables
    • ★ Constructor
    • Accessors
      • get [Symbol.toStringTag]()
    • Methods
      • static create()
      • static isGreater()
      • than()
      • thanEvery()
      • thanSome()
      • valueOf()
  • Inequality {}
    • Overview
    • Generic type variables
    • Constructor
    • Accessors
      • get greater()
      • get less()
    • Properties
      • #greater
      • #less
    • Methods
      • greaterThan()
      • greaterThanEvery()
      • greaterThanSome()
      • lessThan()
      • lessThanEvery()
      • lessThanSome()
  • Less {}
    • Overview
    • Generic type variables
    • ★ Constructor
    • Accessors
      • get [Symbol.toStringTag]()
    • Methods
      • static create()
      • static isLess()
      • than()
      • thanEvery()
      • thanSome()
      • valueOf()
    • Example usage
  • Maximum {}
    • Overview
    • Generic type variables
    • ★ Constructor
    • Accessors
      • get [Symbol.toStringTag]()
    • Methods
      • static create()
      • static isMaximum()
      • valueOf()
  • Minimum {}
    • Overview
    • Generic type variables
    • ★ Constructor
    • Accessors
      • get [Symbol.toStringTag]()
    • Methods
      • static create()
      • static isMinimum()
      • valueOf()
  • Number {}
    • Overview
    • Generic type variables
    • ★ Constructor
    • Methods
      • static create()
      • static isNumber()
      • valueOf()
  • Range {}
    • Overview
    • Generic type variables
    • ★ Constructor
    • Accessors
      • get range()
      • get step()
      • get steps()
      • value()?
      • get [Symbol.toStringTag]()
    • Properties
      • max!
      • min!
      • #maximum
      • #minimum
      • #step
      • #value?
    • Methods
      • ↓ Static
      • static create()
      • static createFrom()
      • static createMaximum()
      • static createMinimum()
      • static isRange()
      • ↓ Instance
      • forEachStep()
      • getCurrentRange()
      • getCurrentStep()
      • ⚠ getMax()
      • ⚠ getMin()
      • getRange()
      • getRangeOfStep()
      • getValueOfStep()
      • has()
      • hasEvery()
      • hasSome()
      • isBetween()
      • isBetweenEvery()
      • isBetweenSome()
      • maxGreaterThan()
      • maxLessThan()
      • minGreaterThan()
      • minLessThan()
      • setValue()
      • setValueToStep()
      • stepByStep()
      • ⚠ toArray()
      • valueDown()
      • ⚠ valueOf()
      • valueUp()
  • Change log
    • Keep a changelog
    • CHANGELOG.md
    • v1.0.0-rc.0
    • v1.0.0-rc
    • v1.0.0-beta.0
  • GIT
    • Commit
    • Semantic Versioning
  • License
    • MIT
  • Social
    • Gettr
    • Twitter
    • YouTube
  • Contact
    • ⋯ Chat
    • @ Email
    • ✆ Phone
  • Donate
    • ฿ Cryptocurrency
    • $ Fiat
Powered by GitBook
On this page
  • Range {}
  • Accessors
  • Properties
  • Methods
Edit on GitHub
  1. Range {}

Overview

The `Range` object

PreviousvalueOf()NextGeneric type variables

Last updated 3 years ago

Range {}

The Range object represents a range between a minimum and maximum.

Accessors

Properties

Methods

public get : Readonly<Array<number>> The accessor obtains the range of an of the to the with the of a specified object.

public get : Step The accessor obtains the step of a specified object.

public get : number Retrieves the of steps of the specified object.

public : number | undefined The value accessor indicates the range current value of the type of a specified object.

public get : string The accessor, with the help of , changes the default tag to 'Range' for an instance of .

public readonly : Max The max read-only property is the maximum range of generic type variable of a specified object.

public readonly : Min; The min read-only property is the minimum range of generic type variable of a specified object.

: Maximum<Max> Private property of the with a primitive value from a given of the constructor indicates the maximum range.

: Minimum<Min> Private property of the with a primitive value from a given of the constructor indicates the minimum range.

: Step The private property of the generic type variable indicates the range step.

: number The private property of the type indicates the range value.

public static : Range<Value> Returns a new instance of with a range of the given required , and optional current , .

public static : Range<number, number, Step> Creates the instance from the given random and the .

public static : Maximum<Value> Returns the instance of the given maximum .

public static : Minimum<Value> Returns the instance of the given minimum .

public static : value is Range<Min, Max> Checks whether the is an instance of of any or the given and range and .

public : this Performs the specified action for each step in the range of an .

public : Readonly<Array<number>> | undefined Returns a range of numbers from to the current by the of a specified object.

public : number | undefined Returns the step of the range .

public : Max Gets the maximum range of a specified object.

public : Min Gets the minimum range of a specified object.

public : number[] Returns range of numbers from to the given with the of a specified object.

public : Readonly<Array<number>> | undefined Returns a range of numbers by the specified from the to the given of a specified object.

public : number | undefined Returns the range value of the given .

public : boolean Checks whether the is in the range of a specified object.

public : boolean Checks whether every value of the given is in the range of a specified object.

public : boolean Checks whether some are in the range of a specified object.

public : boolean Checks whether range of the given and is between the range of a specified object.

public : boolean Checks whether the range of a specified object is between every range of the given .

public : boolean Checks whether the range of a specified object is between some given .

public : boolean Checks whether the is less than the range of a specified object.

public : boolean Checks whether the is greater than the range of a specified object.

public : boolean Checks whether the is less than a range of a specified object.

public : boolean Checks whether the is greater than the range of a specified object.

public : this Sets the range between the and of a specified object.

public : this Sets the of the specified object to the value of the given .

public : this Performs a callback function with the ability to decide when to move to the next step of the range.

public : readonly [Min, Max] Returns a read-only array of the range in order minimum and maximum.

public : Readonly<{ min: Min; max: Max }> Returns a read-only object consisting of the primitive values of and instances.

range()
get
Array
minimum
maximum
step
Range
step()
get
Range
steps()
number
Range
value()
number
Range
[Symbol.toStringTag]()
get
toStringTag
Range
#value?
number
forEachStep()
maximum
Array
getCurrentRange()
minimum
value
step
Range
getCurrentStep()
value
stepByStep()
max!
Range
min!
Range
#maximum
Maximum
primitive wrapper object
Range
#minimum
Minimum
primitive wrapper object
Range
#step
create()
Range
createFrom()
Range
createMaximum()
Maximum
createMinimum()
Minimum
isRange()
Range
getMax()
Range
getMin()
Range
getRange()
minimum
step
Range
getRangeOfStep()
step
minimum
Range
getValueOfStep()
has()
Range
hasEvery()
Range
hasSome()
Range
isBetween()
Range
isBetweenEvery()
Range
isBetweenSome()
Range
maxGreaterThan()
maximum
Range
maxLessThan()
maximum
Range
minGreaterThan()
minimum
Range
minLessThan()
minimum
Range
setValue()
value
minimum
Range
setValueToStep()
value
Range
toArray()
Minimum
Maximum
Logorange/range.class.ts at main · angular-package/rangeGitHub
range.class.ts
Max
Min
Step
value
max
min
value
⚠
⚠
⚠
value
minimum
maximum
step
⚠
min
max
value
step
numbers
step
values
step
value
step
min
max
ranges
value
values
value
value
ranges
value
step
valueOf()
maximum
value