Code Monkey home page Code Monkey logo

overload's Introduction

overload.js

A simple way to overload a function depending on the type of the parameters passed to it.

Usage

Create a mathod taking different types and number of arguments by calling overload. The returned method can be called just like any other function.

var createPerson = overload([String], function(name){
	return "name: "+name;
}).when([String, Number], function(name, age){
	return createPerson(name)+", age: "+age;
}).when([String, Number, Function], function(name, age, callback){
	return callback(name, age);
});



createPerson("JavaScript") //returns 'name: JavaScript'
createPerson("JavaScript", 18) //returns 'name: JavaScript, age: 18'
createPerson("JavaScript", 18, function(name, age){
	return "age: "+age+", name: "+name;
}) //returns 'age: 18, name: JavaScript'

Fallback

If nothing matches, a fallback function will be called:

var myMethod = overload([String], function(value){
	return value.toUpperCase();
}).fallback(function(){
	throw Error("what happened here?" + arguments);
});


myMethod() //throws error

Constructors

You can create your own instances and use the constructor to match

function Person(name, age){
	this.name = name;
	this.age = age;
}

var getAge = overload([Person], function(person){
	return person.age
}).when([Number], function(age){
	return age;
});


getAge(new Person("JavaScript", 18)) //returns 18
getAge(18) //returns 18

MIT Licence

Copyright ©2013 Marius Gundersen All Rights Reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

overload's People

Contributors

chocolateboy avatar mariusgundersen avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

overload's Issues

bower support

Could this also be pushed up to bower?
If you'd like I could make a pr

Edit: Apparently I can't read... There is support for bower although bower and npm aren't mapped to the same module name.
Bower is Overload and npm is overloadjs

Terminology: overloading versus multiple dispatch

Overloading dispatches statically, via static type information (Java). A better term for what you are doing is “multiple dispatch [1]” (Common Lisp, Clojure). You could structure your API like this (possibly with different names):

var createPerson = createMultiMethod();
createPerson.addMethod([String], function (name) { ... });
createPerson.addMethod([String, Number], function (name, age) { ... });
...

[1] http://en.wikipedia.org/wiki/Multiple_dispatch

Invalid UMD

The require statement in the Node support section of the UMD requires nothing and is crashing the r.js optimizer and (I'm assuming) should crash when used in node?

It should be module.exports = factory();

Same Class Name Cause Problem

    <script>
        (function (window) {
            var root = {};
            function Number() { };

            Number.prototype.show = function () {
                console.log("this is root.Number not window.Number");
            };

            root.Number = Number;

            window.test = root;

        })(window);
    </script>
    <script>
        (function (window) {
            console.log(Number === test.Number); //false

            var funcTest = overload([test.Number], function (num) {
                num.show();
            }).when([Number], function (num) {
                console.log(num);
            });

            funcTest(1); //error TypeError: num.show is not a function
        })(window);
    </script>

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.