Skip to content
/ unherit Public

Clone a constructor without affecting the super-class

License

Notifications You must be signed in to change notification settings

wooorm/unherit

Repository files navigation

unherit

Build Coverage Downloads Size

Create a subclass that can be modified without affecting the super class.

Contents

What is this?

This is a tiny package lets you create a subclass, that can be modified, without affecting the super class.

When should I use this?

Not often! You might have some weird cases though.

Install

This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:

npm install unherit

In Deno with esm.sh:

import {unherit} from 'https://esm.sh/unherit@3'

In browsers with esm.sh:

<script type="module">
  import {unherit} from 'https://esm.sh/unherit@3?bundle'
</script>

Use

import {EventEmitter} from 'node:events'
import {unherit} from 'unherit'

// Create a private class which acts just like `EventEmitter`.
const Emitter = unherit(EventEmitter)

Emitter.prototype.defaultMaxListeners = 0
// Now, all instances of `Emitter` have `0` maximum listeners, without affecting
// other `EventEmitter`s.

new Emitter().defaultMaxListeners === 0 // => true
new EventEmitter().defaultMaxListeners === undefined // => true
new Emitter() instanceof EventEmitter // => true

API

This package exports the identifier unherit. There is no default export.

unherit(Super)

Subclass Super.

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.

Contribute

Yes please! See How to Contribute to Open Source.

Security

This package is safe.

License

MIT © Titus Wormer

About

Clone a constructor without affecting the super-class

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project