您如何閱讀 Node.js 中的 API 文檔？

Question

我正在嘗試閱讀https://github.com/mikeal/bent上的文檔。

我不知道如何閱讀async request(url[, body=null, headers={}]) 。 具體來說， ,代表什么？

之前看到過這個問題的答案，也搜索過，但是沒找到。 將其標記為該副本的副本將非常棒。

Answer 1

這是此示例的分步操作：

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

1. async意味着它是一個異步 function，它總是返回一個 promise。
2. url是第一個參數並且是必需的。
3. [, args here ]表示括號內的 arguments 是可選的。
4. [, args here]中的逗號表示如果包含這些 arguments，則需要用逗號將每個參數與前一個參數分開。
5. body=null表示如果不傳遞body參數，默認值為null
6. headers={}表示如果不傳遞headers參數，則默認值為空 object。

所以，你可以這樣稱呼它：

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