Giter Club home page Giter Club logo

aero-overload's Introduction

aero-overload

ECMAScript function/method overloading with support of several approaches: decorator, fluent builder, neat factory.

Contents:

Installation

$ npm install aero-overload

Examples

Decorator syntax

overload.alias(Number, _.isNumber).alias(String, _.isString);

class Test {
  method() {
    return 'default';
  }

  @overload('method' /* name of the oveloaded method */, value => typeof value === 'number' && value > 0 /* predicate list to test arguments array */)
  methodForPositiveNumber(positiveNumber) {
    return `positive number: ${positiveNumber}`;
  }

  @overload('method', Number)
  methodForNumber(number) {
    return 'number';
  }

  @overload('method', String)
  methodForArray(string) {
    return `string: ${string}`;
  }

  @overload('test', value => typeof value === 'number' && value > 0, String)
  methodForPositiveNumberAndString(positiveNumber, string) {
    return `positive number: ${positiveNumber}, string: ${string}`;
  }

  @overload('test', Number, String)
  methodForNumberAndString(number, string) {
    return `number: ${number}, string: ${string}`;
  }
}

var test = new Test;
test.method();
// <- "default"
test.method([]);
// <- "array: []"
test.method(1);
// <- "positive number: 1"
test.method(0);
// <- "number: 0"
test.method('abc');
// <- "string: abc"
test.method(1, 'abc');
// <- "positive number: 1, string: abc"
test.method(0, 'abc');
// <- "number: 0, string: abc"
test.method(0, 1, 2);
// <- error

Fluent builder syntax

var test = overload
  .alias(Window, value => value instanceof Window)
  .build(() => 'fallback')
  .match([], () => 'default')
  .match([Number], () => 'number')
  .match([Window], () => 'window')
  .match([Number, Window], () => 'number, window')
  .match([Window, Number], () => 'window, number');

test();             // default
test(1);            // number
test(window);       // window
test(1, window);    // number, window
test(window, 1);    // window, number
test({});           // fallback

Neat factory syntax

var test = overload
  .alias('number', _.isNumber)
  .alias('string', _.isString)
  .build(
    /* fallback overload always does first */
    () => 'fallback',
    [] /* predicate list */, () => 'default' /* function overload */,
    ['number'], () => 'number',
    ['string'], () => 'string',
    ['number', 'string'], () => 'number, string',
    ['string', 'number'], () => 'string, number'
  );

test();             // default
test(1);            // number
test('abc');        // string
test(1, 'abc');     // number, string
test('abc', 1);     // string, number
test({});           // fallback

License

The MIT License (MIT)

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.