https://github.com/lamansky/is-subclass-of
[Node.js] Returns true if A is a subclass of B.
https://github.com/lamansky/is-subclass-of
Last synced: 3 months ago
JSON representation
[Node.js] Returns true if A is a subclass of B.
- Host: GitHub
- URL: https://github.com/lamansky/is-subclass-of
- Owner: lamansky
- License: mit
- Created: 2018-04-10T15:39:47.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-10T15:40:54.000Z (about 8 years ago)
- Last Synced: 2025-03-02T21:37:52.205Z (over 1 year ago)
- Language: JavaScript
- Size: 1.95 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
README
# is-subclass-of
Returns true if A is a subclass of B.
## Installation
Requires [Node.js](https://nodejs.org/) 6.0.0 or above.
```bash
npm i is-subclass-of
```
## API
The module exports a single function.
### Parameters
1. Bindable: `A` (function): What may or may not be a subclass of B.
2. `B` (function or string): What may or may not be an ancestor of A. You can either provide the class itself or its string name.
### Return Value
* Returns `true` if `A` is a subclass of `B`.
* Otherwise `false`.
## Example
```javascript
const isSubclassOf = require('is-subclass-of')
isSubclassOf(Date, Error) // false
isSubclassOf(Error, Error) // false
isSubclassOf(TypeError, Error) // true
isSubclassOf(RangeError, Error) // true
isSubclassOf(RangeError, 'Error') // true
class A {}
class B extends A {}
isSubclassOf(A, A) // false
isSubclassOf(B, A) // true
isSubclassOf(B, 'A') // true
// Supports the bind operator
TypeError::isSubclassOf(Error) // true
TypeError::isSubclassOf('Error') // true
B::isSubclassOf(A) // true
```
## Related
* [is-class-of](https://github.com/lamansky/is-class-of): Returns true if A is a subclass of B or the same class as B.
* [is-instance-of](https://github.com/lamansky/is-instance-of): Like `instanceof`, but uses class name strings.