wikimedia/mediawiki-extensions-Popups
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups synced 2024-11-23 23:24:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Document schema module

Browse source 
Bug: T158236
Change-Id: I365fbfc1725d92003e902301252d53d4620c2128
This commit is contained in:
Sam Smith 2017-05-22 19:16:17 +01:00
parent af24fe958a
commit 9350df7111
2 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
resources/dist/index.js.map vendored
View file

Binary file not shown.

12
src/schema.js
View file

@ -1,9 +1,17 @@
/**
* @module schema
*/
var mw = window.mediaWiki,
$ = jQuery;
/**
* Creates an instance of an EventLogging schema that can be used to log
* Popups events.
* Creates an instance of the [EventLogging Schema class][0] with a sampling
* rate of `wgPopupsSchemaSamplingRate` if the UA supports [the Beacon API][1]
* or `0` if it doesn't.
*
* [0]: https://github.com/wikimedia/mediawiki-extensions-EventLogging/blob/master/modules/ext.eventLogging.Schema.js
* [1]: https://w3c.github.io/beacon/
*
* @param {mw.Map} config
* @param {Window} window