Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

If IsCallable(callbackfn) is false, throw a TypeError exception.
https://github.com/xotic750/assert-is-callable-x

browser ecmascript nodejs

Last synced: 15 days ago
JSON representation

If IsCallable(callbackfn) is false, throw a TypeError exception.

Awesome Lists containing this project

README

        


Travis status


Dependency status


devDependency status


npm version


jsDelivr hits


bettercodehub score


Coverage Status

## assert-is-callable-x

If IsCallable(callbackfn) is false, throw a TypeError exception.

### `module.exports(value)` ⇒ \*

Tests `callback` to see if it is callable, throws a `TypeError` if it is
not. Otherwise returns the `callback`.

**Kind**: Exported function
**Returns**: \* - Returns `callback` if it is callable.
**Throws**:

- TypeError Throws if `callback` is not a callable.

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

**Example**

```js
import assertIsCallable from 'assert-is-callable-x';

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

assertIsCallable(primitive); // TypeError 'true is not callable'.
assertIsCallable(object); // TypeError '# is not callable'.
assertIsCallable(mySymbol); // TypeError 'Symbol(mySymbol) is not callable'.
assertIsCallable(symObj); // TypeError '# is not callable'.
console.log(assertIsCallable(fn)); // Returns fn.
```