audit.mustEnable plugin

A Plugin API for opting into the pattern of plugins that are disabled by default and must be explicitly enabled by configuration.

Plugin API

mustEnable(): void

Declare that your plugin must be enabled. Any subsequent code will run only when the plugin is enabled by configuration.

jstag.use(plugin => {
  plugin.ns("myPlugin");

  plugin.defaults({
    myPlugin: {
      disabled: true
    }
  });

  plugin.mustEnable();

  // This code is unreachable unless the plugin is enabled
});

Mechanism

This plugin implements non-local return using JavaScript's throw keyword.