nodeJS function documentation syntax

Question

I'm slightly confused by the nodeJS documentation.

For instance, looking at the assert module I instantly see

assert(value[, message])

how exactly do I read this? I understand assert is a function that takes a parameter called value, but what exactly does [, message] mean? Does it mean message is an array? Why does the comma not come before the initial opening bracket?

ninekey · Accepted Answer · 2017-01-25 22:53:32Z

2

The example you provide simply means that the parameter "message" is optional. The documentation states:

If value is not truthy, an AssertionError is thrown with a message property set equal to the value of the message parameter. If the message parameter is undefined, a default error message is assigned.

answered Jan 25, 2017 at 22:53

ninekey

211 bronze badge

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

3 Comments

user3513466 Over a year ago

Oh that makes. So in an example like assert.doesNotThrow(block[, error][, message]) it just means error and message are both optional?

ninekey Over a year ago

Yes. Both parameters "error" and "message" are optional when using the doesNotThrow assertion.

entithat Over a year ago

Where can I find documentation about this?

Collectives™ on Stack Overflow

nodeJS function documentation syntax

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related