Last active
March 31, 2021 11:05
-
-
Save hugolpz/3c094c0a2fc18e31bedfc816d8d08bf0 to your computer and use it in GitHub Desktop.
JSdoc essential
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* @alias .move_to | |
* @description Moves page to new title address. | |
* @param {String} move_to_title - target page's title. | |
* @param {Object} [options] - options. | |
* @param {String} [options.reason] - reason for the move. | |
* @param {Boolean=true} [options.noredirect] - do not leave a redirect. | |
* @returns {Object}- returns (does not exist on .move_to but I put it here for demo) | |
* @memberof Wikiapi.prototype | |
* @example | |
* result = await targetWiki.move_page('Page A', 'Page Alpha', { reason: 'Correcting name.', noredirect: true, movetalk: true }); | |
*/ | |
function wikiapi_move_to(move_to_title,options) { | |
// do stuff here | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment