Package Exports
- assert-is-object-x
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (assert-is-object-x) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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 ifvalue
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.