guardz/dist/typeguards/isNonPositiveNumber.d.ts

A simple and lightweight TypeScript type guard library for runtime type validation.

import type { NonPositiveNumber } from '../types/NonPositiveNumber';
import type { TypeGuardFn } from './isType';
/**
 * Checks if a value is a non-positive number (less than or equal to 0).
 *
 * Note: This includes zero but excludes positive numbers, NaN, and Infinity.
 *
 * @param value - The value to check
 * @param config - Optional configuration for error handling
 * @returns True if the value is a non-positive number, false otherwise
 *
 * @example
 * ```typescript
 * import { isNonPositiveNumber } from 'guardz';
 *
 * console.log(isNonPositiveNumber(0)); // true
 * console.log(isNonPositiveNumber(-1)); // true
 * console.log(isNonPositiveNumber(-42.5)); // true
 * console.log(isNonPositiveNumber(-0.001)); // true
 * console.log(isNonPositiveNumber(1)); // false
 * console.log(isNonPositiveNumber(0.1)); // false
 * console.log(isNonPositiveNumber(NaN)); // false
 * console.log(isNonPositiveNumber(Infinity)); // false
 * console.log(isNonPositiveNumber("-5")); // false
 *
 * // With type narrowing
 * const data: unknown = getUserInput();
 * if (isNonPositiveNumber(data)) {
 *   // data is now typed as NonPositiveNumber
 *   console.log(Math.abs(data)); // Safe to use absolute value
 * }
 * ```
 */
export declare const isNonPositiveNumber: TypeGuardFn<NonPositiveNumber>;