Giter Club home page Giter Club logo

babel-plugin-overload's Introduction

babel-plugin-overload

CircleCI

This is an experimental plugin that allows you to overload operators in your Javascript code.

Compare with Python:

class Addable:
  def __add__(self, other):
    return # Some computation using self and other

In Javascript, using this Babel plugin:

class Addable {
  [Symbol.for('+')] (other) {
    return // some computation using this and other
  }
}

This plugin is still in beta and should be considered highly experimental. I should go without saying that you probably should not use this in your production code.

Example

In

x + y

Out

function (_left, _right) {
  if (_left[Symbol.for("+")]) return _left[Symbol.for("+")](_right);else return _left + _right;
}(x, y);

Supported Operators

At the moment, all binary operators are supported. Unary operators are coming soon.

The full supported list is:

  • The arithmetic operators: +, -, /, *, %, **
  • The bitwise operators: &, |, ^
  • The bitshift operators: >>, <<, >>>, <<<
  • The equality operators: ==, ===, !=, !==
  • The inequality operators: >, <, >=, <=
  • The remaining miscellaneous operators: in and instanceof

To overload any of them, define a method named with the Symbol you get with Symbol.for for the appropriate operator. For instance, use Symbol.for('+') to overload the + operator, and Symbol.for('in') to overload the in operator.

You can define the overloading method on the object itself or anywhere on the object's prototype chain.

At the moment, overloading is only supported for the left side value. Support for overloading on the right side value (the equivalent of Python's __radd__ family of methods) is coming soon.

Installation

$ npm install babel-plugin-overload

Usage

Via .babelrc (Recommended)

.babelrc

{
  "plugins": ["overload"]
}

Via CLI

$ babel --plugins overload script.js

Via Node API

require("babel-core").transform("code", {
  plugins: ["overload"]
});

babel-plugin-overload's People

Contributors

foxbenjaminfox avatar hmhmmhm avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.