docs: 📚️ add documentation on modifications on clientPreferences.js

This commit is contained in:
alistair3149 2024-04-25 14:47:47 -04:00
parent 53ba8747ad
commit 173f093a07
No known key found for this signature in database

View file

@ -1,3 +1,13 @@
/**
* Based on @wikimedia/mediawiki.skins.clientpreferences 1.1.1
*
* @see https://github.com/wikimedia/mediawiki-skins-Vector/tree/master/resources/skins.vector.clientPreferences
*
* Modificactions
* - Use localStoarge instead of cookies
* - Add mw.message wrapper to replace message keys
*/
/**
* @typedef {Object} ClientPreference
* @property {string[]} options that are valid for this client preference