es-toolkit/dist/compat/predicate/conformsTo.d.ts

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

import { ConformsPredicateObject } from "../_internal/ConformsPredicateObject.js";

//#region src/compat/predicate/conformsTo.d.ts
/**
 * Checks if `object` conforms to `source` by invoking the predicate properties of `source` with the corresponding property values of `object`.
 *
 * Note: This method is equivalent to `conforms` when source is partially applied.
 *
 * @template T - The type of the target object.
 * @param target The object to inspect.
 * @param source The object of property predicates to conform to.
 * @returns Returns `true` if `object` conforms, else `false`.
 *
 * @example
 *
 * const object = { 'a': 1, 'b': 2 };
 * const source = {
 *   'a': (n) => n > 0,
 *   'b': (n) => n > 1
 * };
 *
 * console.log(conformsTo(object, source)); // => true
 *
 * const source2 = {
 *   'a': (n) => n > 1,
 *   'b': (n) => n > 1
 * };
 *
 * console.log(conformsTo(object, source2)); // => false
 */
declare function conformsTo<T>(target: T, source: ConformsPredicateObject<T>): boolean;
//#endregion
export { conformsTo };