@monstermann/fn/dist/function/isFalsy.d.ts

A utility library for TypeScript.

//#region src/function/isFalsy.d.ts
type Falsy<T> = T extends unknown ? T extends string ? "" extends T ? "" : never : T extends number ? 0 extends T ? 0 : never : T extends boolean ? false extends T ? false : never : null extends T ? null : undefined extends T ? undefined : never : never;
/**
 * `isFalsy(target)`
 *
 * Checks if a value is falsy (false, 0, "", null, undefined).
 *
 * ```ts
 * isFalsy(false); // true
 * isFalsy(0); // true
 * isFalsy(""); // true
 * isFalsy("hello"); // false
 * ```
 *
 * ```ts
 * pipe(false, isFalsy()); // true
 * pipe("hello", isFalsy()); // false
 * ```
 */
declare const isFalsy: {
  <T>(): (target: T) => target is Falsy<T>;
  <T>(target: T): target is Falsy<T>;
};
//#endregion
export { isFalsy };