How do javascript libraries ignore certain parameters, or make certain function parameters "optional"?

Question

I will use Node.js as an example but I see this in many docs:

(From the net module documentation):

net.createConnection(port, [host], [connectListener])

Creates a TCP connection to port on host. If host is omitted, 'localhost' will be assumed. The connectListener parameter will be added as an listener for the 'connect' event.

This is followed with example code such as the following:

a = net.createConnection(8080, function(c){
    console.log('do something');
});

My question is that the createConnection function takes from 1 - 3 parameters. Above, I passed in two. How is it that Node is able to know the function argument I passed in is meant as the connectListener argument and not the host argument?

Felix Kling · Accepted Answer · 2015-01-08 04:08:18Z

4

If the parameters have different types, you can simply test for them. Here port is probably a number, host a string and connectionListener is a function.

For example:

function createConnection(port, host, connectionListener) {
    if (typeof host === 'function') {
        conectionListener = host;
        host = null;
    }
    if (!host) {
        host = 'localhost';
    }
    // ...
}

Of course this doesn't work if the parameters are of the same type. There is no a general solution for that case.

answered Jan 8, 2015 at 4:08

Felix Kling

820k181 gold badges1.1k silver badges1.2k bronze badges

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

Comments

Dimitar Dimitrov · Accepted Answer · 2015-01-08 04:11:06Z

1

I don't specifically know the implementation of createConnection, but one possible way to do this would be to count the arguments passed to the function as well as checking their type, something like:

function createConnection(port, host, connectListener) {
    var f = connectListener;
    if(arguments.length === 2 && typeof host === "function") {
        f = host;
        host = "localhost";
    }
    console.log("Host: " + host);
    console.log("Port: " + port);
    f();
}

createConnection(8080, function() { 
    console.log("Connecting listener...");
});

Here is a fiddle.

answered Jan 8, 2015 at 4:11

Dimitar Dimitrov

15.2k9 gold badges55 silver badges82 bronze badges

Comments

Gokul Nath KP · Accepted Answer · 2015-01-08 04:03:39Z

0

Maybe it is internally calling net.createConnection(options, [connectionListener]), so that the parameters are mapped properly.

Reference:

http://nodejs.org/api/net.html#net_net_createconnection_options_connectionlistener

answered Jan 8, 2015 at 4:03

Gokul Nath KP

15.6k25 gold badges94 silver badges131 bronze badges

Comments

Community · Accepted Answer · 2017-05-23 12:09:27Z

0

The type can be inspected, thus checking parameter 2 is a function allows such behavior Handling optional parameters in javascript

edited May 23, 2017 at 12:09

CommunityBot

11 silver badge

answered Jan 8, 2015 at 4:06

onaclov2000

5,87111 gold badges43 silver badges55 bronze badges

Collectives™ on Stack Overflow

How do javascript libraries ignore certain parameters, or make certain function parameters "optional"?

4 Answers 4

Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related