Git Product home page Git Product logo

argument's Introduction

Argument

A helper for declaring your assumptions about method arguments.

Usage

Browser style

function someFunction(a, b, c) {
    args(someFunction, function(){
        args.expect(a).toBeDefined();
        args.expect(c).not.toBeTruthy();
    });
}

The same with ES6 syntax

function someFunction(a, b, c) {
    args(someFunction, () => {
        args.expect(a).toBeDefined();
        args.expect(c).not.toBeTruthy();
    });
}

Node.js asynchronous callback style (not recommended)

function someFunction(a, b, c, success, err) {
    if (args(someFunction, 
             function(){ 
                args.expect(a).toBeDefined();
             }, 
             err)) {
        return;
    }
}

Motivation

It is very easy to misuse javascript functions

Inspiration

I had been using Catel for some time and after some initial skepticism found their argument checking extremely useful. In fact I am really convinced that such partial design by contract at arguments level is even more important for such nonrestrictive language as Javascript.

Assertions code for args.expect was heavily borrowed from Jasmine

argument's People

Contributors

auz34 avatar

Watchers

 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.