Package - assert-is-object-x

assert-is-object-x

If IsObject(value) is false, throw a TypeError exception.

`module.exports(value)` ⇒ `*` ⏏

Tests value to see if it is an object, throws a TypeError if it is not. Otherwise returns the value.

Kind: Exported function
Returns: * - Returns value if it is an object.
Throws:

TypeError Throws if value is not an object.

Param	Type	Description
value	`*`	The argument to be tested.
[message]	`string`	Optional alternative message.

Example

import assertIsObject from 'assert-is-object-x';

const primitive = true;
const mySymbol = Symbol('mySymbol');
const symObj = Object(mySymbol);
const object = {};
const fn = function fn() {};

assertIsObject(primitive); // TypeError 'true is not an object'
assertIsObject(mySymbol); // TypeError 'Symbol(mySymbol) is not an object'
assertIsObject(symObj); // Returns symObj.
assertIsObject(object); // Returns object.
assertIsObject(fn); // Returns fn.

Current Tags

3.1.2 ... latest (5 years ago)

assert-is-object-x

module.exports(value) ⇒ * ⏏

Current Tags

42 Versions

`module.exports(value)` ⇒ `*` ⏏