predicates.ts

import type {Buffer} from 'node:buffer';
import {TypedArray} from 'type-fest';
import {StringPredicate} from './predicates/string.js';
import {NumberPredicate} from './predicates/number.js';
import {BigIntPredicate} from './predicates/bigint.js';
import {BooleanPredicate} from './predicates/boolean.js';
import {Predicate, PredicateOptions} from './predicates/predicate.js';
import {ArrayPredicate} from './predicates/array.js';
import {ObjectPredicate} from './predicates/object.js';
import {DatePredicate} from './predicates/date.js';
import {ErrorPredicate} from './predicates/error.js';
import {MapPredicate} from './predicates/map.js';
import {WeakMapPredicate} from './predicates/weak-map.js';
import {SetPredicate} from './predicates/set.js';
import {WeakSetPredicate} from './predicates/weak-set.js';
import {TypedArrayPredicate} from './predicates/typed-array.js';
import {ArrayBufferPredicate} from './predicates/array-buffer.js';
import {DataViewPredicate} from './predicates/data-view.js';
import {BasePredicate} from './predicates/base-predicate.js';
import {AnyPredicate} from './predicates/any.js';

export interface Predicates {
	/**
	Test the value to be a string.
	*/
	readonly string: StringPredicate;

	/**
	Test the value to be a number.
	*/
	readonly number: NumberPredicate;

	/**
	Test the value to be an bigint.
	*/
	readonly bigint: BigIntPredicate;

	/**
	Test the value to be a boolean.
	*/
	readonly boolean: BooleanPredicate;

	/**
	Test the value to be undefined.
	*/
	readonly undefined: Predicate<undefined>;

	/**
	Test the value to be null.
	*/
	readonly null: Predicate<null>;

	/**
	Test the value to be null or undefined.
	*/
	readonly nullOrUndefined: Predicate<null | undefined>;

	/**
	Test the value to be not a number.
	*/
	readonly nan: Predicate<number>;

	/**
	Test the value to be a Symbol.
	*/
	readonly symbol: Predicate<symbol>;

	/**
	Test the value to be an array.
	*/
	readonly array: ArrayPredicate;

	/**
	Test the value to be an object.
	*/
	readonly object: ObjectPredicate;

	/**
	Test the value to be a Date.
	*/
	readonly date: DatePredicate;

	/**
	Test the value to be an Error.
	*/
	readonly error: ErrorPredicate;

	/**
	Test the value to be a Map.
	*/
	readonly map: MapPredicate;

	/**
	Test the value to be a WeakMap.
	*/
	readonly weakMap: WeakMapPredicate;

	/**
	Test the value to be a Set.
	*/
	readonly set: SetPredicate;

	/**
	Test the value to be a WeakSet.
	*/
	readonly weakSet: WeakSetPredicate;

	/**
	Test the value to be a Function.
	*/
	readonly function: Predicate<Function>;

	/**
	Test the value to be a Buffer.
	*/
	readonly buffer: Predicate<Buffer>;

	/**
	Test the value to be a RegExp.
	*/
	readonly regExp: Predicate<RegExp>;

	/**
	Test the value to be a Promise.
	*/
	readonly promise: Predicate<Promise<unknown>>;

	/**
	Test the value to be a typed array.
	*/
	readonly typedArray: TypedArrayPredicate<TypedArray>;

	/**
	Test the value to be a Int8Array.
	*/
	readonly int8Array: TypedArrayPredicate<Int8Array>;

	/**
	Test the value to be a Uint8Array.
	*/
	readonly uint8Array: TypedArrayPredicate<Uint8Array>;

	/**
	Test the value to be a Uint8ClampedArray.
	*/
	readonly uint8ClampedArray: TypedArrayPredicate<Uint8ClampedArray>;

	/**
	Test the value to be a Int16Array.
	*/
	readonly int16Array: TypedArrayPredicate<Int16Array>;

	/**
	Test the value to be a Uint16Array.
	*/
	readonly uint16Array: TypedArrayPredicate<Uint16Array>;

	/**
	Test the value to be a Int32Array.
	*/
	readonly int32Array: TypedArrayPredicate<Int32Array>;

	/**
	Test the value to be a Uint32Array.
	*/
	readonly uint32Array: TypedArrayPredicate<Uint32Array>;

	/**
	Test the value to be a Float32Array.
	*/
	readonly float32Array: TypedArrayPredicate<Float32Array>;

	/**
	Test the value to be a Float64Array.
	*/
	readonly float64Array: TypedArrayPredicate<Float64Array>;

	/**
	Test the value to be a ArrayBuffer.
	*/
	readonly arrayBuffer: ArrayBufferPredicate<ArrayBuffer>;

	/**
	Test the value to be a SharedArrayBuffer.
	*/
	readonly sharedArrayBuffer: ArrayBufferPredicate<SharedArrayBuffer>;

	/**
	Test the value to be a DataView.
	*/
	readonly dataView: DataViewPredicate;

	/**
	Test the value to be Iterable.
	*/
	readonly iterable: Predicate<Iterable<unknown>>;

	/**
	Test that the value matches at least one of the given predicates.
	*/
	any: (<T1>(p1: BasePredicate<T1>) => AnyPredicate<T1>)
	& (<T1, T2>(p1: BasePredicate<T1>, p2: BasePredicate<T2>) => AnyPredicate<T1 | T2>)
	& (<T1, T2, T3>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>) => AnyPredicate<T1 | T2 | T3>)
	& (<T1, T2, T3, T4>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>, p4: BasePredicate<T4>) => AnyPredicate<T1 | T2 | T3 | T4>)
	& (<T1, T2, T3, T4, T5>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>, p4: BasePredicate<T4>, p5: BasePredicate<T5>) => AnyPredicate<T1 | T2 | T3 | T4 | T5>)
	& (<T1, T2, T3, T4, T5, T6>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>, p4: BasePredicate<T4>, p5: BasePredicate<T5>, p6: BasePredicate<T6>) => AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6>)
	& (<T1, T2, T3, T4, T5, T6, T7>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>, p4: BasePredicate<T4>, p5: BasePredicate<T5>, p6: BasePredicate<T6>, p7: BasePredicate<T7>) => AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6 | T7>)
	& (<T1, T2, T3, T4, T5, T6, T7, T8>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>, p4: BasePredicate<T4>, p5: BasePredicate<T5>, p6: BasePredicate<T6>, p7: BasePredicate<T7>, p8: BasePredicate<T8>) => AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8>)
	& (<T1, T2, T3, T4, T5, T6, T7, T8, T9>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>, p4: BasePredicate<T4>, p5: BasePredicate<T5>, p6: BasePredicate<T6>, p7: BasePredicate<T7>, p8: BasePredicate<T8>, p9: BasePredicate<T9>) => AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9>)
	& (<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>, p4: BasePredicate<T4>, p5: BasePredicate<T5>, p6: BasePredicate<T6>, p7: BasePredicate<T7>, p8: BasePredicate<T8>, p9: BasePredicate<T9>, p10: BasePredicate<T10>) => AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9 | T10>)
	& ((...predicate: BasePredicate[]) => AnyPredicate);
}

const predicates = <T>(object: T, options?: PredicateOptions): T & Predicates => {
	Object.defineProperties(object, {
		string: {
			get: (): StringPredicate => new StringPredicate(options),
		},
		number: {
			get: (): NumberPredicate => new NumberPredicate(options),
		},
		bigint: {
			get: (): BigIntPredicate => new BigIntPredicate(options),
		},
		boolean: {
			get: (): BooleanPredicate => new BooleanPredicate(options),
		},
		undefined: {
			get: (): Predicate => new Predicate('undefined', options),
		},
		null: {
			get: (): Predicate => new Predicate('null', options),
		},
		nullOrUndefined: {
			get: (): Predicate => new Predicate('nullOrUndefined', options),
		},
		nan: {
			get: (): Predicate => new Predicate('nan', options),
		},
		symbol: {
			get: (): Predicate => new Predicate('symbol', options),
		},
		array: {
			get: (): ArrayPredicate => new ArrayPredicate(options),
		},
		object: {
			get: (): ObjectPredicate => new ObjectPredicate(options),
		},
		date: {
			get: (): DatePredicate => new DatePredicate(options),
		},
		error: {
			get: (): ErrorPredicate => new ErrorPredicate(options),
		},
		map: {
			get: (): MapPredicate => new MapPredicate(options),
		},
		weakMap: {
			get: (): WeakMapPredicate => new WeakMapPredicate(options),
		},
		set: {
			get: (): SetPredicate => new SetPredicate(options),
		},
		weakSet: {
			get: (): WeakSetPredicate => new WeakSetPredicate(options),
		},
		function: {
			get: (): Predicate => new Predicate('Function', options),
		},
		buffer: {
			get: (): Predicate => new Predicate('Buffer', options),
		},
		regExp: {
			get: (): Predicate<RegExp> => new Predicate('RegExp', options),
		},
		promise: {
			get: (): Predicate => new Predicate('Promise', options),
		},
		typedArray: {
			get: (): TypedArrayPredicate<TypedArray> => new TypedArrayPredicate('TypedArray', options),
		},
		int8Array: {
			get: (): TypedArrayPredicate<Int8Array> => new TypedArrayPredicate('Int8Array', options),
		},
		uint8Array: {
			get: (): TypedArrayPredicate<Uint8Array> => new TypedArrayPredicate('Uint8Array', options),
		},
		uint8ClampedArray: {
			get: (): TypedArrayPredicate<Uint8Array> => new TypedArrayPredicate('Uint8ClampedArray', options),
		},
		int16Array: {
			get: (): TypedArrayPredicate<Int16Array> => new TypedArrayPredicate('Int16Array', options),
		},
		uint16Array: {
			get: (): TypedArrayPredicate<Uint16Array> => new TypedArrayPredicate('Uint16Array', options),
		},
		int32Array: {
			get: (): TypedArrayPredicate<Int32Array> => new TypedArrayPredicate('Int32Array', options),
		},
		uint32Array: {
			get: (): TypedArrayPredicate<Uint32Array> => new TypedArrayPredicate('Uint32Array', options),
		},
		float32Array: {
			get: (): TypedArrayPredicate<Float32Array> => new TypedArrayPredicate('Float32Array', options),
		},
		float64Array: {
			get: (): TypedArrayPredicate<Float64Array> => new TypedArrayPredicate('Float64Array', options),
		},
		arrayBuffer: {
			get: (): ArrayBufferPredicate<ArrayBuffer> => new ArrayBufferPredicate('ArrayBuffer', options),
		},
		sharedArrayBuffer: {
			get: (): ArrayBufferPredicate<SharedArrayBuffer> => new ArrayBufferPredicate('SharedArrayBuffer', options),
		},
		dataView: {
			get: (): DataViewPredicate => new DataViewPredicate(options),
		},
		iterable: {
			get: (): Predicate => new Predicate('Iterable', options),
		},
		any: {
			value: (...predicates: BasePredicate[]): AnyPredicate => new AnyPredicate(predicates, options),
		},
	});

	return object as T & Predicates;
};

export default predicates;

export {ObjectPredicate} from './predicates/object.js';
export type {Shape} from './predicates/object.js';
export {StringPredicate} from './predicates/string.js';
export {NumberPredicate} from './predicates/number.js';
export {BigIntPredicate} from './predicates/bigint.js';
export {BooleanPredicate} from './predicates/boolean.js';
export {ArrayPredicate} from './predicates/array.js';
export {DatePredicate} from './predicates/date.js';
export {ErrorPredicate} from './predicates/error.js';
export {MapPredicate} from './predicates/map.js';
export {WeakMapPredicate} from './predicates/weak-map.js';
export {SetPredicate} from './predicates/set.js';
export {WeakSetPredicate} from './predicates/weak-set.js';
export {TypedArrayPredicate} from './predicates/typed-array.js';
export {ArrayBufferPredicate} from './predicates/array-buffer.js';
export {DataViewPredicate} from './predicates/data-view.js';
export {AnyPredicate} from './predicates/any.js';