MULTI-CLASS

Easy multiple inheritance and composition in JavaScript.

Report a Bug · Request a Feature

Table of Contents

• About the Project
• Getting Started
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

Multi-inheritance/composition is a very useful feature of Object Oriented Programming, but JavaScript's Class syntactic sugar does not allow for extending multiple parent classes. This library provides an easy way to solve that, without the need for mixin chains or functions.

Getting Started

This library has zero dependencies. To get up and running in your project, just go ahead and install.

Installation

Install the library with

npm install @kbravh/multi-class

or

yarn add @kbravh/multi-class

Usage

Import the library, then create a couple of parent classes. A common pattern uses "Has" or "With".

const multiclass = require('@kbravh/multi-class')

class HasName {
  constructor({name}){
    this.name = name
  }
}

class HasAge {
  constructor({age}){
    this.age = age
  }
}

Then, create your subclass and extend the parent classes using the multi-class function.

class Person extends multiclass(HasName, HasAge){
  // The constructor is called implicitly

  getNameAndAge(){
    return `${this.name} is ${this.age} years old.`
  }
}

Finally, create an instance of your new class and see the magic!

let person = new Person({
  age: 22,
  name: "Leeloo"
})

person.getNameAndAge() // Leeloo is 22 years old.

Nota bene: If your parent classes have different parameters for their respective constructors, an easy way to handle this is by passing in all arguments in a JSON object and destructuring them in the constructors, as is done above.

Options

Don't like the name multiclass? Just change the name on import and inherit to your heart's content.

const 🤖 = require('@kbravh/multi-class')

class Person extends 🤖(HasName, HasAge){...}

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b new-feature)
3. Be sure to run linting! (yarn lint)
4. Commit your Changes (git commit -m 'Add something cool!')
5. Push to the Branch (git push origin new-feature)
6. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Karey Higuera - @kbravh - [email protected]

Project Link: https://github.com/kbravh/multi-class