How do you read API documentation in Node.js?

Question

I am trying to read the documentation at https://github.com/mikeal/bent.

I don't know how to read async request(url[, body=null, headers={}]). Specifically, what does the , represent?

I have seen an answer to this question before, and I have searched for it, but I could not find it. Marking this as a duplicate of that would be fantastic.

github.com/mikeal/bent#async-requesturl-bodynull-headers It says the parameters right under it. — yogurtsyum
– yogurtsyum, Commented Apr 3, 2020 at 18:42

jfriend00 · Accepted Answer · 2020-04-03 18:45:31Z

3

Here's a step by step for this example:

async request(url[, body=null, headers={}])

The async means it's an async function that always returns a promise.
url is the first argument and is required.
The [, args here ] means that the arguments inside the brackets are optional.
The comma in [, args here] means that if you include these arguments, then a comma is required to separate each argument from the previous one.
body=null means that if you don't pass the body argument, the default value is null
headers={} means that if you don't pass the headers argument, the default value is an empty object.

So, you can call it like any of these:

request(myUrl).then(...).catch(...)
request(myUrl, myBody).then(...).catch(...)
request(myUrl, myBody, myHeaders).then(...).catch(...)

answered Apr 3, 2020 at 18:45

jfriend00

711k104 gold badges1.1k silver badges1k bronze badges

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

Collectives™ on Stack Overflow

How do you read API documentation in Node.js?

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