https://github.com/xotic750/assert-is-object-x

If IsObject(value) is false, throw a TypeError exception.
https://github.com/xotic750/assert-is-object-x

browser ecmascript nodejs

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/xotic750/assert-is-object-x
• Owner: Xotic750
• License: mit
• Created: 2015-11-26T20:28:36.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T21:54:48.000Z (about 2 years ago)
• Last Synced: 2024-11-07T08:07:03.283Z (3 months ago)
• Topics: browser, ecmascript, nodejs
• Language: JavaScript
• Size: 2.11 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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 if `value` is not an object.

| Param     | Type                | Description                   |

| --------- | ------------------- | ----------------------------- |

| value     | \*     | The argument to be tested.    |

| [message] | string | Optional alternative message. |

**Example**

```js

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.

```