core/killswitch

import { killswitch_status, startKillswitchPolling } from './core/killswitch.js';

// Check if WikiShield is disabled
if (killswitch_status.disabled) {
  console.log("WikiShield is disabled by killswitch");
  return;
}

// Start monitoring the killswitch
startKillswitchPolling(api);

Members

(static, constant) killswitch_config :Object

Description:

• Configuration for the killswitch polling system.

Source:

• core/killswitch.js, line 49

Properties:

Type:

• Object

Example

// To set up the killswitch, create a page at the configured location with this content:
// Page: User:LuniZunie/killswitch.js
// Content:
{
  "disabled": false,
  "forceReload": false
}

// To disable WikiShield:
{
  "disabled": true,
  "forceReload": false
}

// To force all users to reload:
{
  "disabled": false,
  "forceReload": true
}

(static, constant) killswitch_status :Object

Description:

• Killswitch status object with two simple options.

Source:

• core/killswitch.js, line 75

Properties:

Type:

• Object

Example

// Check if WikiShield is disabled
if (killswitch_status.disabled) {
  console.log("WikiShield is disabled");
  return;
}

Methods

(async, static) checkKillswitch(api) → {Promise.<Object>}

Description:

• Check the remote killswitch page and update the global killswitch status.

  This function fetches the killswitch configuration page from Wikipedia, parses the JSON content, and updates the killswitch_status object. If forceReload is detected, it will reload the page immediately.

Source:

• core/killswitch.js, line 102

Example

const status = await checkKillswitch(wikishield.api);
if (status.disabled) {
  console.log("WikiShield has been disabled!");
}

Parameters:

Returns:

Type

Promise.<Object>

(static) startKillswitchPolling(api)

Description:

• Start polling the killswitch page at regular intervals.

  This function begins a polling loop that checks the killswitch configuration at the interval specified in killswitch_config.

Source:

• core/killswitch.js, line 188

Example

startKillswitchPolling(wikishield.api);

Parameters: