27 lines
947 B
TypeScript
27 lines
947 B
TypeScript
/**
|
|
* Checks if the given value is an object. An object is a value that is
|
|
* not a primitive type (string, number, boolean, symbol, null, or undefined).
|
|
*
|
|
* This function tests whether the provided value is an object or not.
|
|
* It returns `true` if the value is an object, and `false` otherwise.
|
|
*
|
|
* This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to an object value.
|
|
*
|
|
* @param {any} value - The value to check if it is an object.
|
|
* @returns {value is object} `true` if the value is an object, `false` otherwise.
|
|
*
|
|
* @example
|
|
* const value1 = {};
|
|
* const value2 = [1, 2, 3];
|
|
* const value3 = () => {};
|
|
* const value4 = null;
|
|
*
|
|
* console.log(isObject(value1)); // true
|
|
* console.log(isObject(value2)); // true
|
|
* console.log(isObject(value3)); // true
|
|
* console.log(isObject(value4)); // false
|
|
*/
|
|
declare function isObject(value?: any): value is object;
|
|
|
|
export { isObject };
|