From 28aad9af384e17fc6192cc58ec1f019141248d93 Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Mon, 19 Feb 2018 20:47:39 -0800 Subject: [PATCH] mw.loader: Document mw.loader.require() as private Only public for debugging purposes. Change-Id: Icc44e11ec6874d7f74ed527e87a80dd06b4edb3a --- resources/src/mediawiki/mediawiki.js | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) 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 -- 2.20.1