MediaWiki:Gadget-libSensitiveIPs.js: Difference between revisions

Revision as of 01:31, 20 September 2016

Revision as of 01:45, 20 September 2016

Line 62:

( function ( $, mw, undefined ) {

'use strict';

var mw.libs.sensitiveIPs; = {

sensitiveIPs = mw.libs.sensitiveIPs = {

/**

* Query the API

},*

* @param {Object} params - API query parameters

*

* @param {string[]} options.test - IP addresses or IP ranges to test for

* sensitivity.

*

* @param {string[]} options.entities - Entity IDs to display data for.

* "Entities" are countries or organizations whose IPs are deemed

* sensitive by Wikipedia. Entity IDs are defined in

* https://en.wikipedia.org/wiki/Module:Sensitive_IP_addresses/list.

*

* @return {$.Promise}

* A jQuery Promise that is resolved with the query result, as a

* JavaScript object. For the structure of the query results, see

* https://en.wikipedia.org/wiki/Module:Sensitive_IP_addresses/API#Results.

*

@example

// Find whether the IP "1.2.3.4" is sensitive.

mw.loader.using( 'ext.gadget.libSensitiveIPs', function () {

sensitiveIPs = mw.libs.sensitiveIPs =.query( {

"test": [ "1.2.3.4" ]

} ).done( function( data ) {

returnconsole.log( data.sensitiveips.matches.length > 0 );

} );

} );

*

*/

query: function ( params ) {

if ( !( params instanceof Object ) ) {

Line 74 ⟶ 103:

func: 'query',

args: [ params ]

} );

},

isSensitive: function ( s ) {

return sensitiveIPs.query( { test: [ s ] } ).then( function ( data ) {

return data.sensitiveips.matches.length > 0;

} );

}