@budsbox/lib-es 2.3.0 → 3.0.0

package/dist/guards.d.ts

@@ -1,195 +0,0 @@
-import type { Def, Nil, NonNil, Undef } from '@budsbox/lib-types';
-import type { Predicate, TypeGuard } from './types.js';
-/**
- * Checks if the provided value is `undefined`.
- *
- * @param value - The value to check for `undefined`.
- * @returns `true` if the value is `undefined`, otherwise `false`.
- */
-export declare function isUndef(value: unknown): value is Undef;
-/**
- * Checks if a given value is defined (not `undefined`).
- *
- * @param value - The value to check.
- * @returns Whether the value is defined.
- */
-export declare function isDef<U>(value: U): value is Def<U>;
-/**
- * Checks if the provided value is `null` or `undefined`.
- *
- * @param value - The value to be checked.
- * @returns Returns `true` if the value is `null` or `undefined`, otherwise `false`.
- */
-export declare function isNil(value: unknown): value is Nil;
-/**
- * Checks if the provided value is not null or undefined.
- *
- * @param value - The value to be checked.
- * @returns Returns true if the value is not null or undefined; otherwise, false.
- */
-export declare function isNotNil<T>(value: T): value is NonNil<T>;
-/**
- * Checks if the provided value is not null or undefined.
- *
- * @param value - The value to be checked.
- * @returns Returns true if the value is not null or undefined; otherwise, false.
- */
-export declare function isNotNil(value: unknown): value is NonNil;
-/**
- * Checks if the provided value is strictly equal to true.
- *
- * @param value - The value to check.
- * @returns Returns true if the value is strictly true, otherwise false.
- */
-export declare function isTrue(value: unknown): value is true;
-/**
- * Determines if the provided value is strictly `false`.
- *
- * @param value - The value to be checked.
- * @returns Returns `true` if the value is `false`, otherwise returns `false`.
- */
-export declare function isFalse(value: unknown): value is false;
-/**
- * Determines if the given value is truly, i.e., converts to true when used in a boolean context.
- *
- * @param value - The value to be tested for truthiness.
- * @returns Returns true if the value is truthy, false otherwise.
- */
-export declare function isTruly(value: unknown): boolean;
-/**
- * Determines if a given value is falsy.
- * A value is considered falsy if it evaluates to false when coerced to a boolean.
- *
- * @param value - The value to be tested.
- * @returns True if the value is falsy, otherwise false.
- */
-export declare function isFalsy(value: unknown): boolean;
-/**
- * Checks if the given value is an object.
- *
- * @param value - The value to check.
- * @returns True if the value is an object, false otherwise.
- */
-export declare function isObject(value: unknown): value is object;
-/**
- * Checks if the provided value is a record.
- *
- * A record is considered an object where the keys are property keys,
- * and the values can be any type. The function also checks whether
- * empty records are allowed based on the specified flag.
- *
- * @param value - The value to check.
- * @param allowEmpty - Determines whether empty records are allowed.
- * @returns A boolean indicating whether the value is a record.
- */
-export declare function isRecord(value: unknown, allowEmpty?: boolean): value is Record<PropertyKey, unknown>;
-/**
- * Checks if the given value is an array.
- *
- * @typeParam T - Type of the value to be checked.
- * @param value - The value to check.
- * @returns True if the value is an array, otherwise false.
- */
-export declare function isArray<T>(value: T | readonly T[]): value is readonly T[];
-/**
- * Checks if the provided value is an array.
- *
- * @typeParam T - type of the value to be checked.
- * @param value - The value to be checked.
- * @returns True if the value is an array, otherwise false.
- */
-export declare function isArray<T>(value: T | T[]): value is T[];
-/**
- * Checks if the given value is an array.
- *
- * @param value - The value to be checked.
- * @returns Returns true if the value is an array, otherwise false.
- */
-export declare function isArray(value: unknown): value is unknown[];
-/**
- * Determines if the provided value is of type Function.
- *
- * @param value - The value to be checked.
- * @returns True if the value is a function; otherwise, false.
- */
-export declare function isFunction<TFn extends CallableFunction = CallableFunction>(value: unknown): value is TFn;
-/**
- * Determines if the provided value is a string.
- *
- * @param value - The value to check.
- * @returns True if the value is a string, otherwise false.
- */
-export declare function isString(value: unknown): value is string;
-/**
- * Checks if the provided value is a number and not NaN.
- *
- * @param value - The value to be checked.
- * @returns Returns true if the value is a number and not NaN, otherwise false.
- */
-export declare function isNumber(value: unknown): value is number;
-/**
- * Checks if the given value is of type boolean.
- *
- * @param value - The value to check.
- * @returns A boolean indicating whether the value is a boolean or not.
- */
-export declare function isBoolean(value: unknown): value is boolean;
-/**
- * Determines if a given property exists on a source object and optionally
- * evaluates it with a provided predicate function.
- *
- * @param source - The object to check for the property existence. Can be `null` or `undefined`.
- * @param prop - The property key to check on the source.
- * @param test - Optional predicate function used to evaluate the property's value.
- * @returns Returns `false` since the source is `null` or `undefined` in this function signature.
- */
-export declare function hasProp(source: Nil, prop: PropertyKey, test?: Predicate<unknown>): false;
-/**
- * Checks if a given property exists on the provided object.
- *
- * @param source - The object to check for the property.
- * @param prop - The property key to check for existence on the object.
- * @returns A boolean indicating whether the property exists on the object.
- */
-export declare function hasProp<TKey extends PropertyKey>(source: NonNil, prop: TKey): source is Record<TKey, unknown>;
-/**
- * Checks if the given object has a specific property that meets the criteria
- * defined by a type guard function.
- *
- * @param source - The object to check for the property.
- * @param prop - The key of the property to check for in the object.
- * @param test - A type guard function that tests the property value against a type.
- * @returns Returns `true` if the object has the specified property and the value passes
- * the type guard, otherwise returns `false`.
- */
-export declare function hasProp<TValue extends NonNil, TKey extends keyof TValue, TNarrowed extends TValue[TKey]>(source: TValue, prop: TKey, test: TypeGuard<Required<TValue>[TKey], TNarrowed>): source is TValue & Record<TKey, TNarrowed>;
-/**
- * Checks if the given `source` object has a property specified by `prop` and verifies
- * that the value of the property satisfies the condition defined by the `test` function.
- *
- * @param source - The object to be checked for the specified property.
- * @param prop - The key of the property to check for existence in the `source`.
- * @param test - A type guard function used to validate the type of the property's value.
- * @returns A boolean indicating whether the `source` has the specified property and the value
- * satisfies the type guard test.
- */
-export declare function hasProp<TKey extends PropertyKey, TNarrowed>(source: unknown, prop: TKey, test: TypeGuard<unknown, TNarrowed>): source is Record<TKey, TNarrowed>;
-/**
- * Checks if a given property exists on a source object and satisfies a specified test condition.
- *
- * @param source - The source object to check for the property.
- * @param prop - The property key to check in the source object.
- * @param test - A predicate function to test the value of the specified property.
- * @returns True if the property exists on the source object and the test predicate returns true; otherwise, false.
- */
-export declare function hasProp<TValue extends NonNil, TKey extends keyof TValue>(source: TValue, prop: TKey, test: Predicate<Required<TValue>[TKey]>): boolean;
-/**
- * Checks if a given property exists on the specified source object and optionally validates it using a predicate function.
- *
- * @param source - The object on which the property check is performed.
- * @param prop - The property key to check for existence in the source object.
- * @param test - An optional predicate function to validate the property value.
- * @returns Returns true if the property exists on the source object and the predicate (if provided) evaluates to true; otherwise, false.
- */
-export declare function hasProp(source: unknown, prop: PropertyKey, test?: Predicate<unknown>): boolean;
-//# sourceMappingURL=guards.d.ts.map

package/dist/guards.js

@@ -1,136 +0,0 @@
-/**
- * Checks if the provided value is `undefined`.
- *
- * @param value - The value to check for `undefined`.
- * @returns `true` if the value is `undefined`, otherwise `false`.
- */
-export function isUndef(value) {
-    return value === undefined;
-}
-/**
- * Checks if a given value is defined (not `undefined`).
- *
- * @param value - The value to be checked.
- * @returns Returns true if the value is defined, otherwise false.
- */
-export function isDef(value) {
-    return value !== undefined;
-}
-/**
- * Checks if the provided value is `null` or `undefined`.
- *
- * @param value - The value to be checked.
- * @returns Returns `true` if the value is `null` or `undefined`, otherwise `false`.
- */
-export function isNil(value) {
-    return value == null;
-}
-export function isNotNil(value) {
-    return !isNil(value);
-}
-/**
- * Checks if the provided value is strictly equal to true.
- *
- * @param value - The value to check.
- * @returns Returns true if the value is strictly true, otherwise false.
- */
-export function isTrue(value) {
-    return value === true;
-}
-/**
- * Determines if the provided value is strictly `false`.
- *
- * @param value - The value to be checked.
- * @returns Returns `true` if the value is `false`, otherwise returns `false`.
- */
-export function isFalse(value) {
-    return value === false;
-}
-/**
- * Determines if the given value is truly, i.e., converts to true when used in a boolean context.
- *
- * @param value - The value to be tested for truthiness.
- * @returns Returns true if the value is truthy, false otherwise.
- */
-export function isTruly(value) {
-    return Boolean(value);
-}
-/**
- * Determines if a given value is falsy.
- * A value is considered falsy if it evaluates to false when coerced to a boolean.
- *
- * @param value - The value to be tested.
- * @returns True if the value is falsy, otherwise false.
- */
-export function isFalsy(value) {
-    return !isTruly(value);
-}
-/**
- * Checks if the given value is an object.
- *
- * @param value - The value to check.
- * @returns True if the value is an object, false otherwise.
- */
-export function isObject(value) {
-    return value != null && typeof value === 'object';
-}
-/**
- * Checks if the provided value is a record.
- *
- * A record is considered an object where the keys are property keys,
- * and the values can be any type. The function also checks whether
- * empty records are allowed based on the specified flag.
- *
- * @param value - The value to check.
- * @param allowEmpty - Determines whether empty records are allowed.
- * @returns A boolean indicating whether the value is a record.
- */
-export function isRecord(value, allowEmpty = false) {
-    return isObject(value) && (allowEmpty || Object.keys(value).length > 0);
-}
-export function isArray(value) {
-    return Array.isArray(value);
-}
-/**
- * Determines if the provided value is of type Function.
- *
- * @param value - The value to be checked.
- * @returns True if the value is a function; otherwise, false.
- */
-// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
-export function isFunction(value) {
-    return typeof value === 'function';
-}
-/**
- * Determines if the provided value is a string.
- *
- * @param value - The value to check.
- * @returns True if the value is a string, otherwise false.
- */
-export function isString(value) {
-    return typeof value === 'string';
-}
-/**
- * Checks if the provided value is a number and not NaN.
- *
- * @param value - The value to be checked.
- * @returns Returns true if the value is a number and not NaN, otherwise false.
- */
-export function isNumber(value) {
-    return typeof value === 'number' && !Number.isNaN(value);
-}
-/**
- * Checks if the given value is of type boolean.
- *
- * @param value - The value to check.
- * @returns A boolean indicating whether the value is a boolean or not.
- */
-export function isBoolean(value) {
-    return typeof value === 'boolean';
-}
-export function hasProp(source, prop, test) {
-    return (isNotNil(source) &&
-        Object.hasOwn(source, prop) &&
-        (!isFunction(test) || test(source[prop])));
-}
-//# sourceMappingURL=guards.js.map

package/dist/random.d.ts

@@ -1,19 +0,0 @@
-import type { RNG } from './types.js';
-export type { RNG };
-/**
- * Generates a hash value for the given string using the FNV-1a hashing algorithm.
- *
- * @param seed - The input string to hash.
- * @returns The 32-bit unsigned integer hash of the input string.
- */
-export declare function fnv1aHash(seed: string): number;
-/**
- * Generates a pseudo-random number generator (PRNG) based on the Mulberry32 algorithm.
- *
- * @param seed - The seed for the random number generator. It can be a string or a numeric value.
- * If a string is provided, it will be hashed into a numeric value before use.
- * @returns An object containing the seed and a `next` function that produces the next pseudo-random
- * number in the sequence as a floating-point value in the range [0, 1).
- */
-export declare function mulberry32(seed: string | number): RNG;
-//# sourceMappingURL=random.d.ts.map

package/dist/random.js

@@ -1,35 +0,0 @@
-import { isString } from '#guards';
-/**
- * Generates a hash value for the given string using the FNV-1a hashing algorithm.
- *
- * @param seed - The input string to hash.
- * @returns The 32-bit unsigned integer hash of the input string.
- */
-export function fnv1aHash(seed) {
-    let h = 2166136261 >>> 0;
-    for (let i = 0; i < seed.length; i += 1) {
-        h ^= seed.charCodeAt(i);
-        h = Math.imul(h, 16777619);
-    }
-    return h >>> 0;
-}
-/**
- * Generates a pseudo-random number generator (PRNG) based on the Mulberry32 algorithm.
- *
- * @param seed - The seed for the random number generator. It can be a string or a numeric value.
- * If a string is provided, it will be hashed into a numeric value before use.
- * @returns An object containing the seed and a `next` function that produces the next pseudo-random
- * number in the sequence as a floating-point value in the range [0, 1).
- */
-export function mulberry32(seed) {
-    seed = isString(seed) ? fnv1aHash(seed) : seed;
-    let t = seed >>> 0;
-    const next = () => {
-        t += 0x6d2b79f5;
-        let x = Math.imul(t ^ (t >>> 15), 1 | t);
-        x ^= x + Math.imul(x ^ (x >>> 7), 61 | x);
-        return ((x ^ (x >>> 14)) >>> 0) / 4294967296;
-    };
-    return { seed, next };
-}
-//# sourceMappingURL=random.js.map