I am currently working on documenting custom function types within an object and would greatly appreciate any assistance:
A Closer Look at the Issue
Consider this basic object declaration with several function properties (addCoordinate, addCoordinateOne, addCoordinateTwo). We will explore these functions as three examples and discuss why they may not be functioning as expected.
/**
* @typedef {Object} Point
* @property {number} x - The X Coordinate
* @property {number} y - The Y Coordinate
*/
/**
* @typedef {Object} Shape
* @property {Point} startCoordinate - the starting coordinate
* @property {Point[]} coordinates - An array of point coordinates
* @property {(x:string, y:string) => void} addCoordinate - Updates the point
* @property {addCoordinateOne} addCoordinateOne - Updates the point
* @property {addCoordinateTwo} addCoordinateTwo - Updates the point
*/
/** @type {Shape} */
const square = {}
Example A
@property {(x:string, y:string) => void} addCoordinate - Updates the point
This example works as intended, but lacks reusability for my specific needs.
https://i.stack.imgur.com/BSud0.png
Example B
/**
* @typedef {Function} addCoordinateOne
* @param {string} X
* @param {string} Y
*/
While this example somewhat functions by recognizing the custom function type, it does not properly parse the parameters. I have followed the documentation for the @typedef tag:
https://i.stack.imgur.com/4LbHS.png
Example C
/**
* @function addCoordinateTwo
* @param {string} X
* @param {string} Y
*/
This example fails to work entirely, despite following JSDoc's recommended approach using the @function tag.
The Query at Hand
Is there a way to make Example B or C function similarly to Example A?