nhb-toolbox/dist/dts/number/range.d.ts

A versatile collection of smart, efficient, and reusable utility functions, classes and types for everyday development needs.

import type { NumberType, RangedNumbers, RangeOptions } from './types';
/**
 * * Function to get numbers within a range based on the provided {@link NumberType} and options.
 *
 * @remarks Returns either string or array of numbers based on the {@link RangeOptions.getAsString getAsString} option.
 *
 * @param type - The type of numbers to generate ('random', 'prime', etc.).
 * @param options - Options to configure number generation, including range and formatting.
 * @returns The numbers in the range based on {@link type} and {@link options} either as string or array of numbers.
 */
export declare function getNumbersInRange<T extends boolean = false>(type?: NumberType, options?: RangeOptions<T>): RangedNumbers<T>;