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 GetAs>(
  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:

Property	Type	Default	Description
getAs	'array' or 'string'	'array'	Output format
min	number	0	Range minimum
max	number	100	Range maximum
includeMin	boolean	true	Include minimum value
includeMax	boolean	true	Include maximum value
separator	string	','	String separator (when getAs='string')
multiplesOf	number	undefined	Filter for multiples of this number

Return Value

Returns either:

• number[] when getAs='array'
• string when getAs='string'

Example Usage

Basic Range

import { getNumbersInRange } from 'nhb-toolbox';

// Get all numbers from 1 to 10
console.log(getNumbersInRange('any', { min: 1, max: 10 }));
// [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

Prime Numbers

// Get primes between 10 and 30 as a string
console.log(getNumbersInRange('prime', { 
  min: 10, 
  max: 30, 
  getAs: 'string' 
}));
// "11,13,17,19,23,29"

Custom Formatting

// Get even multiples of 5 from 0-100 with custom separator
console.log(getNumbersInRange('even', {
  min: 0,
  max: 100,
  multiplesOf: 5,
  getAs: 'string',
  separator: ' | '
}));
// "0 | 10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90 | 100"

Types

NumberType

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

RangeOptions<T>

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

RangedNumbers<T>

type RangedNumbers<T extends GetAs> = T extends 'array' ? number[] : string;

Notes

1. Range Handling:

   • Automatically swaps min/max if provided in reverse order
   • Respects includeMin/includeMax boundaries

2. Special Cases:

   • multiplesOf is ignored when type is 'prime'
   • 'natural' type forces minimum to be ≥1
   • 'random' type shuffles the results

3. Performance:

   • For large ranges, consider specifying exact multiples rather than filtering
   • Prime checking becomes slower with larger numbers

Use Cases

• Generating number sequences for mathematical operations
• Creating datasets for visualization
• Game development (spawn points, damage values)
• Educational tools for number theory
• Data sampling and quantization

Conclusion

The getNumbersInRange function provides a flexible way to generate and format number sequences with precise control over range, type, and output format. Its combination of filtering options and output formatting makes it useful for a wide variety of numerical operations.