Get Numbers In Range

getNumbersInRange

The getNumbersInRange function generates a sequence of numbers within a specified range, with various filtering and formatting options. It can produce different types of number sequences (primes, odds, evens, etc.) and return them either as an array or a formatted string.

Function Signature

function getNumbersInRange<T extends boolean = false>(
  type?: NumberType,
  options?: RangeOptions<T>
): RangedNumbers<T>

Parameters

type (optional)

Specifies the type of numbers to generate:

• 'any': All numbers in range (default)
• 'natural': Natural numbers (≥1)
• 'odd': Odd numbers
• 'even': Even numbers
• 'prime': Prime numbers
• 'random': Random numbers within each step

options (optional)

Configuration object with these properties:

Return Value

• number[] when getAsString is false (default).
• string when getAsString is true.

Examples

Notes & Special Cases

• Range Handling: Automatically swaps min/max if provided in reverse order. Respects includeMin/includeMax boundaries.
• multiplesOf: Multiples filtering is ignored when type is 'prime'.
• 'natural': Forces minimum to be 1 or greater.
• 'random': Shuffles the generated number sequence.

Types

NumberType

type NumberType = 'any' | 'natural' | 'odd' | 'even' | 'prime' | 'random';

RangeOptions<T>

interface RangeOptions<T extends boolean = false> {
  min?: number;
  max?: number;
  includeMin?: boolean;
  includeMax?: boolean;
  multiplesOf?: number;
  getAsString?: T;
  separator?: string;
}

RangedNumbers<T>

type RangedNumbers<T extends boolean = false> = T extends true ? string : number[];