diff options
Diffstat (limited to 'node_modules/@sapphire/utilities/dist/lib/filterNullAndUndefinedAndZero.d.ts')
-rw-r--r-- | node_modules/@sapphire/utilities/dist/lib/filterNullAndUndefinedAndZero.d.ts | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/node_modules/@sapphire/utilities/dist/lib/filterNullAndUndefinedAndZero.d.ts b/node_modules/@sapphire/utilities/dist/lib/filterNullAndUndefinedAndZero.d.ts new file mode 100644 index 0000000..06f6d76 --- /dev/null +++ b/node_modules/@sapphire/utilities/dist/lib/filterNullAndUndefinedAndZero.d.ts @@ -0,0 +1,24 @@ +import type { Nullish } from './types'; +/** + * 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] + * ``` + */ +export declare function filterNullAndUndefinedAndZero<TValue>(value: TValue | Nullish | 0): value is TValue; +export { filterNullAndUndefinedAndZero as filterNullishAndZero }; +export { +/** + * @deprecated Will be removed in the next major version, switch to either `filterNullishAndZero` or {@link filterNullAndUndefinedAndZero}. + */ +filterNullAndUndefinedAndZero as filterNullishOrZero }; +//# sourceMappingURL=filterNullAndUndefinedAndZero.d.ts.map
\ No newline at end of file |