jsdoc: lib/api/util.js

lib/api/util.js

@@ -6,9 +6,30 @@ const {
 } = require('../core/errors')
 
 const { chunksDecode } = require('./readable')
+/**
+ * @type {131072}
+ */
 const CHUNK_LIMIT = 128 * 1024
 
-async function getResolveErrorBodyCallback ({ callback, body, contentType, statusCode, statusMessage, headers }) {
+/**
+ *
+ * @param {object} options
+ * @param {(err?: Error) => void} options.callback
+ * @param {AsyncIterable<Buffer>} options.body
+ * @param {string} options.contentType
+ * @param {number} options.statusCode
+ * @param {string} options.statusMessage
+ * @param {object} options.headers
+ * @returns
+ */
+async function getResolveErrorBodyCallback ({
+  callback,
+  body,
+  contentType,
+  statusCode,
+  statusMessage,
+  headers
+}) {
   assert(body)
 
   let chunks = []
@@ -55,6 +76,10 @@ async function getResolveErrorBodyCallback ({ callback, body, contentType, statu
   queueMicrotask(() => callback(new ResponseStatusCodeError(message, statusCode, headers, payload)))
 }
 
+/**
+ * @param {string} contentType
+ * @returns {contentType is `application/json${string}`}`
+ */
 const isContentTypeApplicationJson = (contentType) => {
   return (
     contentType.length > 15 &&
@@ -77,6 +102,10 @@ const isContentTypeApplicationJson = (contentType) => {
   )
 }
 
+/**
+ * @param {string} contentType
+ * @returns {contentType is `text/${string}`}`
+ */
 const isContentTypeText = (contentType) => {
   return (
     contentType.length > 4 &&