Array like argument in function documentation

Question

Sorry if my question is stupid, all of us have seen many function arguments for methods documented as this

redis.createClient(port[, host][, options])

I'm unable to understand how it works the port and why host argument is in array and it starts with ,. The snippet above is from

https://github.com/NodeRedis/node_redis

Thanks

natiiix · Accepted Answer · 2019-01-25 21:24:31Z

1

It is not an array. Square brackets are typically used in this manner to indicate optional parameters.

Basically it means that you can use it as any one of the following:

redis.createClient(port)
redis.createClient(port, host)
redis.createClient(port, options)
redis.createClient(port, host, options)

Sometimes the notation redis.createClient(port[, host[, options]]) is used instead, which implies it is not possible to use it as redis.createClient(port, options).

Similar notation is also used when documenting commands. (e.g., from ls manual: ls [OPTION]... [FILE]...)

answered Jan 25, 2019 at 21:24

natiiix

1,2671 gold badge16 silver badges23 bronze badges

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

Collectives™ on Stack Overflow

Array like argument in function documentation

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related