From 9aaa52b1f1f5ba0a29c4c988280822b8433aa5f4 Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Tue, 10 Feb 2015 03:40:07 +0000 Subject: [PATCH] mediawiki.util: Document optional first parameter of getUrl() There was already a test for it, but the documentation didn't reflect it. Elaborate test to also cover case of default title with additional query parameters. Change-Id: I147054fc89a1a79c4aa8d3cfa861926515080a94 --- resources/src/mediawiki/mediawiki.util.js | 2 +- .../qunit/suites/resources/mediawiki/mediawiki.util.test.js | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/resources/src/mediawiki/mediawiki.util.js b/resources/src/mediawiki/mediawiki.util.js index 0dde8734ad..d2022704a9 100644 --- a/resources/src/mediawiki/mediawiki.util.js +++ b/resources/src/mediawiki/mediawiki.util.js @@ -88,7 +88,7 @@ /** * Get the link to a page name (relative to `wgServer`), * - * @param {string} str Page name + * @param {string|null} [str=wgPageName] Page name * @param {Object} [params] A mapping of query parameter names to values, * e.g. `{ action: 'edit' }` * @return {string} Url of the page with name of `str` diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.util.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.util.test.js index 95112f3aa5..3f19a64d36 100644 --- a/tests/qunit/suites/resources/mediawiki/mediawiki.util.test.js +++ b/tests/qunit/suites/resources/mediawiki/mediawiki.util.test.js @@ -35,7 +35,7 @@ } ); } ); - QUnit.test( 'getUrl', 4, function ( assert ) { + QUnit.test( 'getUrl', 5, function ( assert ) { // Not part of startUp module mw.config.set( 'wgArticlePath', '/wiki/$1' ); mw.config.set( 'wgPageName', 'Foobar' ); @@ -49,6 +49,9 @@ href = mw.util.getUrl(); assert.equal( href, '/wiki/Foobar', 'default title' ); + href = mw.util.getUrl( null, { action: 'edit' } ); + assert.equal( href, '/wiki/Foobar?action=edit', 'default title with query string' ); + href = mw.util.getUrl( 'Sandbox', { action: 'edit' } ); assert.equal( href, '/wiki/Sandbox?action=edit', 'simple title with query string' ); } ); -- 2.20.1