Module: permissions

This module facilitates checking that required permissions are provided in the WebExtensions manifest.

Source:

Methods

(static) check(options) → {boolean}

Check that the WebExtensions manifest includes specified API and origin permissions.

Parameters:
Name Type Description
options Object
Properties
Name Type Attributes Default Description
requiredPermissions Array.<string> <optional>
 []

WebExtensions API permissions that are required.
suggestedPermissions Array.<string> <optional>
 []

WebExtensions API permissions that are recommended.
requiredOrigins Array.<string> <optional>
 []

Origin permissions that are required.
suggestedOrigins Array.<string> <optional>
 []

Origin permissions that are recommended.
requiredContentSecurityPolicy ContentSecurityPolicy <optional>
 {}

Content Security Policy directives that are required.
suggestedContentSecurityPolicy ContentSecurityPolicy <optional>
 {}

Content Security Policy directives that are recommended.
warn string <optional>
 true

Whether to output any missing required or suggested permissions with console.warn().
module string <optional>
 "moduleNameNotProvided"

The name of the module having its permissions checked, used in warning output.
Source:
Returns:

Whether the WebExtensions manifest includes the required WebExtensions API permissions, origin permissions, and Content Security Policy directives.

Type
boolean

(static) getManifestOriginMatchPatterns()

Retrieve the origin match patterns permitted by the extension manifest.

Source:

Type Definitions

ContentSecurityPolicy

An object where keys are Content Security Policy directive names and values are arrays of directive values.

Type:
  • Object
Source:
Example
{
  "script-src": [ "'self'", "www.example.com" ],
  "object-src": [ 'self' ]
}