CODEWITHSUNDEEP
javascriptjsdoc
Niekert
Niekert

Reputation: 947

JSDoc - Function parameter should be property of object

I have an object that defines a set of actions like so:

var actions = {
    close: "action_close",
    renderPreview: "action_renderpreview",
    switchToMobile: "action_switchmobile",
    switchToTablet: "action_switchtablet",
    openConfiguration: "action_configuration",
    save: "action_save"
};

Then I have a method that I use to bind these actions to a function like so: 

/**
 * Add an event handler to a toolbar action
 * @param {actions.<prop>} action - The action to bind
 * @param {string} fnCallback - The function to invoke when the action is executed
 */
function onAction(action, fnCallback) {
    this.actionHandlers[action] = fnCallback;
}

I want to use JSDoc to document that the action parameter of the onAction function should be the value of a property of the actions object. Obviously {actions.<prop>} is not the right way to do it but I was wondering if there is an easy way to achieve this.

I could document the action param as {string}, but then any random string can be passed to the onAction function, which I am trying to avoid using proper JSDoc documentation.

It might be a really straightforward solution or not possible at all / unnecessary. Either way, I can't figure it out! Thank you!

Upvotes: 0

Views: 1717

Answers (1)

Sulthan
Sulthan

Reputation: 130082

You are looking at it the wrong way. When you are declaring actions, declare a specific type for the property:

/**
 * @typedef {string} MyAction
 * @typedef {object} Actions
 * @property {MyAction} prop
 */

then you can use directly that type

/**
 * ...
 * @param {MyAction} action - The action to bind
 */

However, that will still allow any string. To limit the string values to a specific set, you will need jsdoc enum.

/**
 * Actions.
 * @readonly
 * @enum {string}
 */
var actions = {
   close: "action_close",
   ...
};

Upvotes: 1

Related Questions