extension_types.json

{
  "id": "extensionTypes",
  "description": "The <code>browser.extensionTypes</code> API contains type declarations for WebExtensions.",
  "definitions": {},
  "refs": {},
  "types": {
    "ImageFormat": {
      "type": "string",
      "enum": [
        "jpeg",
        "png"
      ],
      "description": "The format of an image."
    },
    "ImageDetails": {
      "type": "object",
      "description": "Details about the format, quality, area and scale of the capture.",
      "properties": {
        "format": {
          "allOf": [
            {
              "$ref": "#/types/ImageFormat"
            },
            {
              "description": "The format of the resulting image.  Default is <code>\"jpeg\"</code>."
            }
          ]
        },
        "quality": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100,
          "description": "When format is <code>\"jpeg\"</code>, controls the quality of the resulting image.  This value is ignored for PNG images.  As quality is decreased, the resulting image will have more visual artifacts, and the number of bytes needed to store it will decrease."
        },
        "rect": {
          "type": "object",
          "description": "The area of the document to capture, in CSS pixels, relative to the page.  If omitted, capture the visible viewport.",
          "properties": {
            "x": {
              "type": "number"
            },
            "y": {
              "type": "number"
            },
            "width": {
              "type": "number"
            },
            "height": {
              "type": "number"
            }
          },
          "required": [
            "x",
            "y",
            "width",
            "height"
          ]
        },
        "scale": {
          "type": "number",
          "description": "The scale of the resulting image.  Defaults to <code>devicePixelRatio</code>."
        },
        "resetScrollPosition": {
          "type": "boolean",
          "description": "If true, temporarily resets the scroll position of the document to 0. Only takes effect if rect is also specified."
        }
      }
    },
    "RunAt": {
      "type": "string",
      "enum": [
        "document_start",
        "document_end",
        "document_idle"
      ],
      "description": "The soonest that the JavaScript or CSS will be injected into the tab."
    },
    "CSSOrigin": {
      "type": "string",
      "enum": [
        "user",
        "author"
      ],
      "description": "The origin of the CSS to inject, this affects the cascading order (priority) of the stylesheet."
    },
    "InjectDetails": {
      "type": "object",
      "description": "Details of the script or CSS to inject. Either the code or the file property must be set, but both may not be set at the same time.",
      "properties": {
        "code": {
          "type": "string",
          "description": "JavaScript or CSS code to inject.<br><br><b>Warning:</b><br>Be careful using the <code>code</code> parameter. Incorrect use of it may open your extension to <a href=\"https://en.wikipedia.org/wiki/Cross-site_scripting\">cross site scripting</a> attacks."
        },
        "file": {
          "type": "string",
          "description": "JavaScript or CSS file to inject."
        },
        "allFrames": {
          "type": "boolean",
          "description": "If allFrames is <code>true</code>, implies that the JavaScript or CSS should be injected into all frames of current page. By default, it's <code>false</code> and is only injected into the top frame."
        },
        "matchAboutBlank": {
          "type": "boolean",
          "description": "If matchAboutBlank is true, then the code is also injected in about:blank and about:srcdoc frames if your extension has access to its parent document. Code cannot be inserted in top-level about:-frames. By default it is <code>false</code>."
        },
        "frameId": {
          "type": "integer",
          "minimum": 0,
          "description": "The ID of the frame to inject the script into. This may not be used in combination with <code>allFrames</code>."
        },
        "runAt": {
          "allOf": [
            {
              "$ref": "#/types/RunAt"
            },
            {
              "default": "document_idle",
              "description": "The soonest that the JavaScript or CSS will be injected into the tab. Defaults to \"document_idle\"."
            }
          ]
        },
        "cssOrigin": {
          "allOf": [
            {
              "$ref": "#/types/CSSOrigin"
            },
            {
              "description": "The css origin of the stylesheet to inject. Defaults to \"author\"."
            }
          ]
        }
      }
    },
    "Date": {
      "anyOf": [
        {
          "type": "string",
          "format": "date"
        },
        {
          "type": "integer",
          "minimum": 0
        },
        {
          "type": "object",
          "isInstanceOf": "Date",
          "additionalProperties": {}
        }
      ]
    },
    "ExtensionFileOrCode": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "file": {
              "$ref": "manifest#/types/ExtensionURL"
            }
          },
          "required": [
            "file"
          ]
        },
        {
          "type": "object",
          "properties": {
            "code": {
              "type": "string"
            }
          },
          "required": [
            "code"
          ]
        }
      ]
    },
    "PlainJSONValue": {
      "description": "A plain JSON value",
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "number"
        },
        {
          "type": "string"
        },
        {
          "type": "boolean"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/types/PlainJSONValue"
          }
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/types/PlainJSONValue"
          }
        }
      ]
    }
  }
}