From: Timo Tijhof Date: Tue, 20 Feb 2018 04:47:39 +0000 (-0800) Subject: mw.loader: Document mw.loader.require() as private X-Git-Tag: 1.31.0-rc.0~566^2 X-Git-Url: http://git.cyclocoop.org/%7B%24admin_url%7Dmembres/Subpage_test/1/2/%5B%27/%40%20%27icone_supprimer_signature%27%20=%3E%20%27Delete%20this%20signature%27%2C%20%27icone_valider_signature%27%20=%3E%20%27Validate%20this%20signature%27%2C%20%27image_administrer_rubrique%27%20=%3E%20%27You%20can%20manage%20this%20section%27%2C-%27impossible_modifier_login_auteur%27%20=%3E%20%27Login%20cannot%20be%20changed.%27%2C-%27impossible_modifier_pass_auteur%27%20=%3E%20%27Password%20cannot%20be%20changed.%27%2C%20%27info_1_article%27%20=%3E%20%271%20article%27%2C-%27info_1_article_syndique%27%20=%3E%20%271%20syndicated%20article%27%2C%20%27info_1_auteur%27%20=%3E%20%271%20author%27%2C%20%27info_1_message%27%20=%3E%20%271%20message%27%2C%20%27info_1_mot_cle%27%20=%3E%20%271%20keyword%27%2C%20%27info_1_rubrique%27%20=%3E%20%271%20section%27%2C-%27info_1_site%27%20=%3E%20%271%20site%27%2C%20%27info_1_visiteur%27%20=%3E%20%271%20visitor%27%2C%20%27info_activer_cookie%27%20=%3E%20%27You%20can%20activate%20an%20%3Cb%3Eadministration%20cookie%3C/b%3E%2C%20which%20allows%20you%20%20to%20switch%20easily%20between%20the%20public%20site%20and%20the%20private%20area.%27%2C%40%40%20-249%2C16%20%20213%2C13%20%40%40%20Do%20not%20submit%20this%20import%20request.%3Cp%3EFor%20more%20information%2C%20please%20see%20%3Ca%20href=?a=commitdiff_plain;h=28aad9af384e17fc6192cc58ec1f019141248d93;p=lhc%2Fweb%2Fwiklou.git mw.loader: Document mw.loader.require() as private Only public for debugging purposes. Change-Id: Icc44e11ec6874d7f74ed527e87a80dd06b4edb3a --- diff --git a/resources/src/mediawiki/mediawiki.js b/resources/src/mediawiki/mediawiki.js index e9efc1668f..a2e071e11a 100644 --- a/resources/src/mediawiki/mediawiki.js +++ b/resources/src/mediawiki/mediawiki.js @@ -1982,6 +1982,12 @@ * OO.compare( [ 1 ], [ 1 ] ); * } ); * + * Example of inline dependency obtained via `require()`: + * + * mw.loader.using( [ 'mediawiki.util' ], function ( require ) { + * var util = require( 'mediawiki.util' ); + * } ); + * * Since MediaWiki 1.23 this also returns a promise. * * Since MediaWiki 1.28 the promise is resolved with a `require` function. @@ -2154,9 +2160,14 @@ /** * Get the exported value of a module. * - * Modules may provide this via their local `module.exports`. + * This static method is publicly exposed for debugging purposes + * only and must not be used in production code. In production code, + * please use the dynamically provided `require()` function instead. * - * @protected + * In case of lazy-loaded modules via mw.loader#using(), the returned + * Promise provides the function, see #using() for examples. + * + * @private * @since 1.27 * @param {string} moduleName Module name * @return {Mixed} Exported value