Type alias Predicates

Type declaration

• any: (<T>(...predicates) => AnyPredicate<{
      [K in keyof T]: T[K] extends BasePredicate<infer U>
          ? U
          : never
  }[number]>)

  Test that the value matches at least one of the given predicates.

  • • <T>(...predicates): AnyPredicate<{
          [K in keyof T]: T[K] extends BasePredicate<infer U>
              ? U
              : never
      }[number]>

    • Type Parameters

      • T extends readonly BasePredicate[]

      Parameters

      • Rest ...predicates: T

      Returns AnyPredicate<{
          [K in keyof T]: T[K] extends BasePredicate<infer U>
              ? U
              : never
      }[number]>

• Readonly array: ArrayPredicate

  Test the value to be an array.

• Readonly arrayBuffer: ArrayBufferPredicate<ArrayBuffer>

  Test the value to be a ArrayBuffer.

• Readonly bigint: BigIntPredicate

  Test the value to be an bigint.

• Readonly boolean: BooleanPredicate

  Test the value to be a boolean.

• Readonly dataView: DataViewPredicate

  Test the value to be a DataView.

• Readonly date: DatePredicate

  Test the value to be a Date.

• Readonly error: ErrorPredicate

  Test the value to be an Error.

• Readonly float32Array: TypedArrayPredicate<Float32Array>

  Test the value to be a Float32Array.

• Readonly float64Array: TypedArrayPredicate<Float64Array>

  Test the value to be a Float64Array.

• Readonly function: Predicate<Function>

  Test the value to be a Function.

• Readonly int16Array: TypedArrayPredicate<Int16Array>

  Test the value to be a Int16Array.

• Readonly int32Array: TypedArrayPredicate<Int32Array>

  Test the value to be a Int32Array.

• Readonly int8Array: TypedArrayPredicate<Int8Array>

  Test the value to be a Int8Array.

• Readonly iterable: Predicate<Iterable<unknown>>

  Test the value to be Iterable.

• Readonly map: MapPredicate

  Test the value to be a Map.

• Readonly nan: Predicate<number>

  Test the value to be not a number.

• Readonly null: Predicate<null>

  Test the value to be null.

• Readonly nullOrUndefined: Predicate<null | undefined>

  Test the value to be null or undefined.

• Readonly number: NumberPredicate

  Test the value to be a number.

• Readonly object: ObjectPredicate

  Test the value to be an object.

• Readonly promise: Predicate<Promise<unknown>>

  Test the value to be a Promise.

• Readonly regExp: Predicate<RegExp>

  Test the value to be a RegExp.

• Readonly set: SetPredicate

  Test the value to be a Set.

• Readonly sharedArrayBuffer: ArrayBufferPredicate<SharedArrayBuffer>

  Test the value to be a SharedArrayBuffer.

• Readonly string: StringPredicate

  Test the value to be a string.

• Readonly symbol: Predicate<symbol>

  Test the value to be a Symbol.

• Readonly typedArray: TypedArrayPredicate<TypedArray>

  Test the value to be a typed array.

• Readonly uint16Array: TypedArrayPredicate<Uint16Array>

  Test the value to be a Uint16Array.

• Readonly uint32Array: TypedArrayPredicate<Uint32Array>

  Test the value to be a Uint32Array.

• Readonly uint8Array: TypedArrayPredicate<Uint8Array>

  Test the value to be a Uint8Array.

• Readonly uint8ClampedArray: TypedArrayPredicate<Uint8ClampedArray>

  Test the value to be a Uint8ClampedArray.

• Readonly undefined: Predicate<undefined>

  Test the value to be undefined.

• Readonly weakMap: WeakMapPredicate

  Test the value to be a WeakMap.

• Readonly weakSet: WeakSetPredicate

  Test the value to be a WeakSet.