Matthias Mullie has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/364175 )
Change subject: Fix mw.storage typehint
......................................................................
Fix mw.storage typehint
Change-Id: I758ca9375c479098edae98a78c1ee9170df7afc2
---
M resources/mmv/mmv.Config.js
M resources/mmv/ui/mmv.ui.metadataPanel.js
M resources/mmv/ui/mmv.ui.metadataPanelScroller.js
M tests/qunit/mmv/mmv.testhelpers.js
4 files changed, 10 insertions(+), 10 deletions(-)
git pull
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/MultimediaViewer
refs/changes/75/364175/1
diff --git a/resources/mmv/mmv.Config.js b/resources/mmv/mmv.Config.js
index 8589a2b..15b247e 100644
--- a/resources/mmv/mmv.Config.js
+++ b/resources/mmv/mmv.Config.js
@@ -26,7 +26,7 @@
* @param {mw.Map} mwConfig
* @param {Object} mwUser
* @param {mw.Api} api
- * @param {mw.storage} localStorage
+ * @param {mw.SafeStorage} localStorage
*/
function Config( viewerConfig, mwConfig, mwUser, api, localStorage ) {
/**
@@ -55,7 +55,7 @@
/**
* The localStorage object, for dependency injection
- * @type {mw.storage}
+ * @type {mw.SafeStorage}
*/
this.localStorage = localStorage;
}
diff --git a/resources/mmv/ui/mmv.ui.metadataPanel.js
b/resources/mmv/ui/mmv.ui.metadataPanel.js
index 182173f..ec20a13 100644
--- a/resources/mmv/ui/mmv.ui.metadataPanel.js
+++ b/resources/mmv/ui/mmv.ui.metadataPanel.js
@@ -29,7 +29,7 @@
* @param {jQuery} $aboveFold The brighter headline of the metadata
panel (.mw-mmv-above-fold).
* Called "aboveFold" for historical reasons, but actually a part of
the next sibling of the element
* is also above the fold (bottom of the screen).
- * @param {mw.storage} localStorage the localStorage object, for
dependency injection
+ * @param {mw.SafeStorage} localStorage the localStorage object, for
dependency injection
* @param {mw.mmv.Config} config A configuration object.
*/
function MetadataPanel( $container, $aboveFold, localStorage, config ) {
@@ -185,7 +185,7 @@
/**
* Initializes the header, which contains the title, credit, and
license elements.
*
- * @param {mw.storage} localStorage the localStorage object, for
dependency injection
+ * @param {mw.SafeStorage} localStorage the localStorage object, for
dependency injection
*/
MPP.initializeHeader = function ( localStorage ) {
this.progressBar = new mw.mmv.ui.ProgressBar( this.$aboveFold );
diff --git a/resources/mmv/ui/mmv.ui.metadataPanelScroller.js
b/resources/mmv/ui/mmv.ui.metadataPanelScroller.js
index 2f2c204..fcad104 100644
--- a/resources/mmv/ui/mmv.ui.metadataPanelScroller.js
+++ b/resources/mmv/ui/mmv.ui.metadataPanelScroller.js
@@ -26,14 +26,14 @@
* @constructor
* @param {jQuery} $container The container for the panel
(.mw-mmv-post-image).
* @param {jQuery} $aboveFold The control bar element
(.mw-mmv-above-fold).
- * @param {mw.storage} localStorage the localStorage object, for
dependency injection
+ * @param {mw.SafeStorage} localStorage the localStorage object, for
dependency injection
*/
function MetadataPanelScroller( $container, $aboveFold, localStorage ) {
mw.mmv.ui.Element.call( this, $container );
this.$aboveFold = $aboveFold;
- /** @property {mw.storage} localStorage */
+ /** @property {mw.SafeStorage} localStorage */
this.localStorage = localStorage;
/** @property {boolean} panelWasOpen state flag which will be
used to detect open <-> closed transitions */
diff --git a/tests/qunit/mmv/mmv.testhelpers.js
b/tests/qunit/mmv/mmv.testhelpers.js
index 4010883..de85531 100644
--- a/tests/qunit/mmv/mmv.testhelpers.js
+++ b/tests/qunit/mmv/mmv.testhelpers.js
@@ -33,7 +33,7 @@
* Creates an mw.storage-like object.
*
* @param {Object} storage localStorage stub with getItem, setItem,
removeItem methods
- * @return {mw.storage} Local storage-like object
+ * @return {mw.SafeStorage} Local storage-like object
*/
MTH.createLocalStorage = function ( storage ) {
return new ( Object.getPrototypeOf( mw.storage ) ).constructor(
storage );
@@ -42,7 +42,7 @@
/**
* Returns an mw.storage that mimicks lack of localStorage support.
*
- * @return {mw.storage} Local storage-like object
+ * @return {mw.SafeStorage} Local storage-like object
*/
MTH.getUnsupportedLocalStorage = function () {
return this.createLocalStorage( undefined );
@@ -51,7 +51,7 @@
/**
* Returns an mw.storage that mimicks localStorage being disabled in
browser.
*
- * @return {mw.storage} Local storage-like object
+ * @return {mw.SafeStorage} Local storage-like object
*/
MTH.getDisabledLocalStorage = function () {
var e = function () {
@@ -69,7 +69,7 @@
* Returns a fake local storage which is not saved between reloads.
*
* @param {Object} [initialData]
- * @return {mw.storage} Local storage-like object
+ * @return {mw.SafeStorage} Local storage-like object
*/
MTH.getFakeLocalStorage = function ( initialData ) {
var bag = new mw.Map();
--
To view, visit https://gerrit.wikimedia.org/r/364175
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I758ca9375c479098edae98a78c1ee9170df7afc2
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/MultimediaViewer
Gerrit-Branch: master
Gerrit-Owner: Matthias Mullie <mmul...@wikimedia.org>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
