o
Version:
common object helper functions
24 lines (23 loc) • 530 B
TypeScript
import { IncludesOptions, OObject } from './types';
/**
* Check if an object includes the specified value
*
* @example
* ```
* const a = { a: 1, b: 2, c: 3 };
* const b = { a: 1, b: { c: 2 } };
*
* includes(a, 1); // => true
* includes(b, 2); // => false
* includes(b, 2, {
* follow: true,
* }); // => true
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function includes(obj: OObject, value: any, options?: IncludesOptions): boolean;
export default includes;