Javascript/jQuery: Varying parameters on a custom function

Question

I'm writing a plugin that will allow parameters to 'set it up.' But I predict the user won't always want to set up every aspect of the function.

function This_Function(a,b,c,d);

For instance, maybe they'll only want to set up a and c, but not b and d (they'll just prefer to leave those as defaults). How do I write the function (or the parameters for that matter) so that the user can customize which functions they would prefer to pass? I have a feeling it involves parsing input, but I've seen many other functions with this capability.

Thanks in advance for the help.

PetersenDidIt · Accepted Answer · 2010-03-27 20:54:42Z

7

function This_Function(options){
    // set up the defaults;
    var settings = {
        'opt1':2,
        'opt2': 'foobar'
    };
    $.extend(settings,options);
    if (settings.opt1 > 10) {
        //do stuff
    }
}

Will let you users do something like this:

This_Function();
This_Function({'opt1':30});
This_Function({'opt2':'jquery'});
This_Function({'opt1':20,'opt2':'javascript'});

answered Mar 27, 2010 at 20:54

PetersenDidIt

25.6k3 gold badges69 silver badges72 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Plynx Over a year ago

If you're using JQuery, this is the way to do it.

PetersenDidIt Over a year ago

Figured if they added the jQuery tag they were using jQuery

dclowd9901 Over a year ago

This is exactly what I was looking for. You're a saint, Plynx.

plodder · Accepted Answer · 2010-03-27 20:58:06Z

1

A more transparent way...

function This_Function(options) {
    var a = options.a;
    var b = options.b;
    var c = options.c;
    var d = options.d;
}

This_Function({a:12; c:'hello'; d:1);

answered Mar 27, 2010 at 20:58

plodder

2,25418 silver badges19 bronze badges

1 Comment

dclowd9901 Over a year ago

This is great, too. Thanks. I gave you +1.

dclowd9901 · Accepted Answer · 2013-04-06 17:34:11Z

0

I think the answer I was really looking for for this problem was this one:

function bacon(){
    for( var i in arguments ){
        if( arguments.hasOwnProperty(i) ){
            console.log( arguments[i] );
        }
    }
}

bacon( 'foo', 'bar', 'baz', 'boz' );

// 'foo'
// 'bar'
// 'baz'
// 'boz'

To make sure the arguments you're utilizing are legitimate parameters being passed to the function, you should check each property with .hasOwnProperty().

Only took me 3 years to figure it out :)

answered Apr 6, 2013 at 17:34

dclowd9901

6,8469 gold badges46 silver badges65 bronze badges

Collectives™ on Stack Overflow

Javascript/jQuery: Varying parameters on a custom function

3 Answers 3

3 Comments

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related