Revision history [back]
 | 1 | initial version |
Type hinting for the request body of an express js application in JSDoc can be implemented using the following syntax:
/**
* @typedef {Object} RequestBody
* @property {string} name - The name of the user
* @property {number} age - The age of the user
*/
/**
* @route POST /users
* @param {RequestBody} req.body - The request body
* @returns {void}
*/
In this example, we define a new type called RequestBody using the @typedef tag. This type is an object with two properties: name of type string, and age of type number.
We then use the @param tag to specify that the req.body parameter for the POST /users route should be of type RequestBody.
By using type hinting in this way, we can provide more information about the expected shape of the request body for our API, which can help with debugging and documentation.