succulent/build/types/number.d.ts

Powerful and easy runtime type checking

import { Schema } from "../schema.js";
/**
 * Checks if the value is a primitive `number`.
 * @example
 * ```ts
 * guard(1, $number); // ok!
 * guard(1n, $number); // will throw a `TypeError`
 * guard("1", $number); // will throw a `TypeError`
 * ```
 */
export declare const $number: Schema<number>;
/**
 * @example
 * ```ts
 * guard(1, $int); // ok!
 * guard(1.0, $int); // ok! (because `float` isn't really a type in JavaScript)
 * guard(1.1, $int); // will throw a `TypeError`
 * ```
 */
export declare const $int: Schema<number>;
/**
 * @example
 * ```ts
 * guard(1, $finite); // ok!
 * guard(2**128, $finite); // ok!
 * guard(1n, $finite); // will throw a `TypeError`, because `bigint` isn't a `number`
 * guard(Infinity, $finite); // will throw a `TypeError`, for more obvious reasons
 * guard(Number.NEGATIVE_INFINITY, $finite); // also throws a `TypeError`
 * ```
 */
export declare const $finite: Schema<number>;
/**
 * @example
 * ```ts
 * guard(1n, $bigint); // ok!
 * guard(1, $bigint); // will throw a `TypeError`
 * ```
 */
export declare const $bigint: Schema<bigint>;