@sapphire/utilities/dist/esm/lib/filterNullAndUndefinedAndZero.d.mts

Common JavaScript utilities for the Sapphire Community

import { Nullish } from './types.mjs';

/**
 * Checks whether a value is not `null` nor `undefined` nor `0`.
 * This can be used in {@link Array.filter} to remove `null`, `undefined` from the array type
 * @param value The value to verify that is neither `null`, `undefined` nor `0`
 * @returns A boolean that is `true` if the value is neither `null`, `undefined` nor `0`, false otherwise.
 * @example
 * ```typescript
 * // TypeScript Type: (string | number | undefined | null)[]
 * const someArray = ['one', 'two', undefined, null, 0, 1];
 *
 * // TypeScript Type: (string | number)[]
 * const filteredArray = someArray.filter(filterNullAndUndefinedAndZero);
 * // Result: ['one', 'two', 1]
 * ```
 */
declare function filterNullAndUndefinedAndZero<TValue>(value: TValue | Nullish | 0): value is TValue;

export { filterNullAndUndefinedAndZero, filterNullAndUndefinedAndZero as filterNullishAndZero, filterNullAndUndefinedAndZero as filterNullishOrZero };