tiny-types/src/predicates/isDefined.ts

A tiny library that brings Tiny Types to JavaScript and TypeScript

import { Predicate } from './Predicate';

/**
 * @desc Ensures that the `value` is defined as anything other than {@link null} or {@link undefined}.
 *
 * @example
 * import { ensure, isDefined, TinyType } from 'tiny-types';
 *
 * class Name extends TinyType {
 *     constructor(public readonly value: string) {
 *       ensure('Name', value, isDefined());
 *     }
 * }
 *
 * @returns {Predicate<T>}
 */
export function isDefined<T>(): Predicate<T> {
    return Predicate.to(`be defined`, (value: T) =>
        ! (value === null || value === undefined),
    );
}