Files
common/packages/util/src/is/object.ts
T
2021-11-18 09:57:26 +02:00

27 lines
666 B
TypeScript

// Copyright 2017-2021 @polkadot/util authors & contributors
// SPDX-License-Identifier: Apache-2.0
interface ObjectIndexed {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
[index: string]: any;
}
/**
* @name isObject
* @summary Tests for an `object`.
* @description
* Checks to see if the input value is a JavaScript object.
* @example
* <BR>
*
* ```javascript
* import { isObject } from '@polkadot/util';
*
* isObject({}); // => true
* isObject('something'); // => false
* ```
*/
export function isObject <T extends ObjectIndexed = ObjectIndexed> (value?: unknown): value is T {
return !!value && typeof value === 'object';
}