Enumeration of available Chrome APIs in extension background pages using Electron v9.0.0-beta.1

extension-background-apis-enumerated.json

// generated using
// https://gist.github.com/samuelmaddock/fb54ddc47b7a958ded1f799861239a87
{
  "alarms": {
    "onAlarm": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "clear": "() => any",
    "clearAll": "() => any",
    "create": "() => any",
    "get": "() => any",
    "getAll": "() => any"
  },
  "declarativeNetRequest": {
    "getDynamicRules": "() => any",
    "getMatchedRules": "() => any",
    "setActionCountAsBadgeText": "() => any",
    "updateDynamicRules": "() => any",
    "DomainType": {
      "FIRST_PARTY": "firstParty",
      "THIRD_PARTY": "thirdParty"
    },
    "RemoveHeaderType": {
      "COOKIE": "cookie",
      "REFERER": "referer",
      "SET_COOKIE": "setCookie"
    },
    "ResourceType": {
      "CSP_REPORT": "csp_report",
      "FONT": "font",
      "IMAGE": "image",
      "MAIN_FRAME": "main_frame",
      "MEDIA": "media",
      "OBJECT": "object",
      "OTHER": "other",
      "PING": "ping",
      "SCRIPT": "script",
      "STYLESHEET": "stylesheet",
      "SUB_FRAME": "sub_frame",
      "WEBSOCKET": "websocket",
      "XMLHTTPREQUEST": "xmlhttprequest"
    },
    "RuleActionType": {
      "ALLOW": "allow",
      "ALLOW_ALL_REQUESTS": "allowAllRequests",
      "BLOCK": "block",
      "REDIRECT": "redirect",
      "REMOVE_HEADERS": "removeHeaders",
      "UPGRADE_SCHEME": "upgradeScheme"
    },
    "SourceType": {
      "DYNAMIC": "dynamic",
      "MANIFEST": "manifest"
    },
    "GETMATCHEDRULES_QUOTA_INTERVAL": 10,
    "MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL": 20,
    "MAX_NUMBER_OF_DYNAMIC_RULES": 5000,
    "MAX_NUMBER_OF_RULES": 30000
  },
  "declarativeWebRequest": {
    "onMessage": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onRequest": {
      "addRules": "() => any",
      "removeRules": "() => any",
      "getRules": "() => any"
    },
    "AddRequestCookieInstanceType": {
      "DECLARATIVE_WEB_REQUEST.ADD_REQUEST_COOKIE": "declarativeWebRequest.AddRequestCookie"
    },
    "AddResponseCookieInstanceType": {
      "DECLARATIVE_WEB_REQUEST.ADD_RESPONSE_COOKIE": "declarativeWebRequest.AddResponseCookie"
    },
    "AddResponseHeaderInstanceType": {
      "DECLARATIVE_WEB_REQUEST.ADD_RESPONSE_HEADER": "declarativeWebRequest.AddResponseHeader"
    },
    "CancelRequestInstanceType": {
      "DECLARATIVE_WEB_REQUEST.CANCEL_REQUEST": "declarativeWebRequest.CancelRequest"
    },
    "EditRequestCookieInstanceType": {
      "DECLARATIVE_WEB_REQUEST.EDIT_REQUEST_COOKIE": "declarativeWebRequest.EditRequestCookie"
    },
    "EditResponseCookieInstanceType": {
      "DECLARATIVE_WEB_REQUEST.EDIT_RESPONSE_COOKIE": "declarativeWebRequest.EditResponseCookie"
    },
    "IgnoreRulesInstanceType": {
      "DECLARATIVE_WEB_REQUEST.IGNORE_RULES": "declarativeWebRequest.IgnoreRules"
    },
    "RedirectByRegExInstanceType": {
      "DECLARATIVE_WEB_REQUEST.REDIRECT_BY_REG_EX": "declarativeWebRequest.RedirectByRegEx"
    },
    "RedirectRequestInstanceType": {
      "DECLARATIVE_WEB_REQUEST.REDIRECT_REQUEST": "declarativeWebRequest.RedirectRequest"
    },
    "RedirectToEmptyDocumentInstanceType": {
      "DECLARATIVE_WEB_REQUEST.REDIRECT_TO_EMPTY_DOCUMENT": "declarativeWebRequest.RedirectToEmptyDocument"
    },
    "RedirectToTransparentImageInstanceType": {
      "DECLARATIVE_WEB_REQUEST.REDIRECT_TO_TRANSPARENT_IMAGE": "declarativeWebRequest.RedirectToTransparentImage"
    },
    "RemoveRequestCookieInstanceType": {
      "DECLARATIVE_WEB_REQUEST.REMOVE_REQUEST_COOKIE": "declarativeWebRequest.RemoveRequestCookie"
    },
    "RemoveRequestHeaderInstanceType": {
      "DECLARATIVE_WEB_REQUEST.REMOVE_REQUEST_HEADER": "declarativeWebRequest.RemoveRequestHeader"
    },
    "RemoveResponseCookieInstanceType": {
      "DECLARATIVE_WEB_REQUEST.REMOVE_RESPONSE_COOKIE": "declarativeWebRequest.RemoveResponseCookie"
    },
    "RemoveResponseHeaderInstanceType": {
      "DECLARATIVE_WEB_REQUEST.REMOVE_RESPONSE_HEADER": "declarativeWebRequest.RemoveResponseHeader"
    },
    "RequestMatcherInstanceType": {
      "DECLARATIVE_WEB_REQUEST.REQUEST_MATCHER": "declarativeWebRequest.RequestMatcher"
    },
    "SendMessageToExtensionInstanceType": {
      "DECLARATIVE_WEB_REQUEST.SEND_MESSAGE_TO_EXTENSION": "declarativeWebRequest.SendMessageToExtension"
    },
    "SetRequestHeaderInstanceType": {
      "DECLARATIVE_WEB_REQUEST.SET_REQUEST_HEADER": "declarativeWebRequest.SetRequestHeader"
    },
    "Stage": {
      "ON_AUTH_REQUIRED": "onAuthRequired",
      "ON_BEFORE_REQUEST": "onBeforeRequest",
      "ON_BEFORE_SEND_HEADERS": "onBeforeSendHeaders",
      "ON_HEADERS_RECEIVED": "onHeadersReceived"
    },
    "RequestMatcher": {
      "new": "(parameters) => any"
    },
    "CancelRequest": {
      "new": "(parameters) => any"
    },
    "RedirectRequest": {
      "new": "(parameters) => any"
    },
    "SetRequestHeader": {
      "new": "(parameters) => any"
    },
    "RemoveRequestHeader": {
      "new": "(parameters) => any"
    },
    "AddResponseHeader": {
      "new": "(parameters) => any"
    },
    "RemoveResponseHeader": {
      "new": "(parameters) => any"
    },
    "RedirectToTransparentImage": {
      "new": "(parameters) => any"
    },
    "RedirectToEmptyDocument": {
      "new": "(parameters) => any"
    },
    "RedirectByRegEx": {
      "new": "(parameters) => any"
    },
    "IgnoreRules": {
      "new": "(parameters) => any"
    },
    "AddRequestCookie": {
      "new": "(parameters) => any"
    },
    "AddResponseCookie": {
      "new": "(parameters) => any"
    },
    "EditRequestCookie": {
      "new": "(parameters) => any"
    },
    "EditResponseCookie": {
      "new": "(parameters) => any"
    },
    "RemoveRequestCookie": {
      "new": "(parameters) => any"
    },
    "RemoveResponseCookie": {
      "new": "(parameters) => any"
    },
    "SendMessageToExtension": {
      "new": "(parameters) => any"
    }
  },
  "displaySource": {
    "onSessionErrorOccured": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onSessionTerminated": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onSinksUpdated": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "getAvailableSinks": "() => any",
    "requestAuthentication": "() => any",
    "startSession": "() => any",
    "terminateSession": "() => any",
    "AuthenticationMethod": {
      "PBC": "PBC",
      "PIN": "PIN"
    },
    "ErrorType": {
      "CAPABILITIES_NEGOTIATION_ERROR": "capabilities_negotiation_error",
      "CONNECTION_ERROR": "connection_error",
      "MEDIA_PIPELINE_ERROR": "media_pipeline_error",
      "TIMEOUT_ERROR": "timeout_error",
      "UNKNOWN_ERROR": "unknown_error"
    },
    "SinkState": {
      "CONNECTED": "Connected",
      "CONNECTING": "Connecting",
      "DISCONNECTED": "Disconnected"
    }
  },
  "dns": {
    "resolve": "() => any"
  },
  "extension": {
    "onMessageExternal": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onMessage": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onConnectExternal": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onConnect": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "sendNativeMessage": "() => any",
    "sendMessage": "() => any",
    "connectNative": "() => any",
    "connect": "() => any",
    "getURL": "() => any",
    "inIncognitoContext": false
  },
  "idle": {
    "onStateChanged": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "queryState": "() => any",
    "setDetectionInterval": "() => any",
    "IdleState": {
      "ACTIVE": "active",
      "IDLE": "idle",
      "LOCKED": "locked"
    }
  },
  "management": {
    "getPermissionWarningsByManifest": "() => any",
    "getSelf": "() => any",
    "uninstallSelf": "() => any",
    "ExtensionDisabledReason": {
      "PERMISSIONS_INCREASE": "permissions_increase",
      "UNKNOWN": "unknown"
    },
    "ExtensionInstallType": {
      "ADMIN": "admin",
      "DEVELOPMENT": "development",
      "NORMAL": "normal",
      "OTHER": "other",
      "SIDELOAD": "sideload"
    },
    "ExtensionType": {
      "EXTENSION": "extension",
      "HOSTED_APP": "hosted_app",
      "LEGACY_PACKAGED_APP": "legacy_packaged_app",
      "LOGIN_SCREEN_EXTENSION": "login_screen_extension",
      "PACKAGED_APP": "packaged_app",
      "THEME": "theme"
    },
    "LaunchType": {
      "OPEN_AS_PINNED_TAB": "OPEN_AS_PINNED_TAB",
      "OPEN_AS_REGULAR_TAB": "OPEN_AS_REGULAR_TAB",
      "OPEN_AS_WINDOW": "OPEN_AS_WINDOW",
      "OPEN_FULL_SCREEN": "OPEN_FULL_SCREEN"
    }
  },
  "power": {
    "releaseKeepAwake": "() => any",
    "requestKeepAwake": "() => any",
    "Level": {
      "DISPLAY": "display",
      "SYSTEM": "system"
    }
  },
  "printerProvider": {
    "onPrintRequested": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onGetCapabilityRequested": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onGetUsbPrinterInfoRequested": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onGetPrintersRequested": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "PrintError": {
      "FAILED": "FAILED",
      "INVALID_DATA": "INVALID_DATA",
      "INVALID_TICKET": "INVALID_TICKET"
    }
  },
  "runtime": {
    "onRestartRequired": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onMessageExternal": "[Circular]",
    "onMessage": "[Circular]",
    "onConnectNative": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onConnectExternal": "[Circular]",
    "onConnect": "[Circular]",
    "onBrowserUpdateAvailable": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onUpdateAvailable": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onSuspendCanceled": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onSuspend": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onInstalled": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onStartup": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "connect": "() => any",
    "connectNative": "() => any",
    "getBackgroundPage": "() => any",
    "getManifest": "() => any",
    "getPackageDirectoryEntry": "() => any",
    "getPlatformInfo": "() => any",
    "getURL": "() => any",
    "openOptionsPage": "() => any",
    "reload": "() => any",
    "requestUpdateCheck": "() => any",
    "restart": "() => any",
    "restartAfterDelay": "() => any",
    "sendMessage": "() => any",
    "sendNativeMessage": "() => any",
    "setUninstallURL": "() => any",
    "OnInstalledReason": {
      "CHROME_UPDATE": "chrome_update",
      "INSTALL": "install",
      "SHARED_MODULE_UPDATE": "shared_module_update",
      "UPDATE": "update"
    },
    "OnRestartRequiredReason": {
      "APP_UPDATE": "app_update",
      "OS_UPDATE": "os_update",
      "PERIODIC": "periodic"
    },
    "PlatformArch": {
      "ARM": "arm",
      "MIPS": "mips",
      "MIPS64": "mips64",
      "X86_32": "x86-32",
      "X86_64": "x86-64"
    },
    "PlatformNaclArch": {
      "ARM": "arm",
      "MIPS": "mips",
      "MIPS64": "mips64",
      "X86_32": "x86-32",
      "X86_64": "x86-64"
    },
    "PlatformOs": {
      "ANDROID": "android",
      "CROS": "cros",
      "LINUX": "linux",
      "MAC": "mac",
      "OPENBSD": "openbsd",
      "WIN": "win"
    },
    "RequestUpdateCheckStatus": {
      "NO_UPDATE": "no_update",
      "THROTTLED": "throttled",
      "UPDATE_AVAILABLE": "update_available"
    }
  },
  "storage": {
    "sync": {
      "get": "() => any",
      "set": "() => any",
      "remove": "() => any",
      "clear": "() => any",
      "getBytesInUse": "() => any",
      "onChanged": {
        "addListener": "() => any",
        "removeListener": "() => any",
        "hasListener": "() => any",
        "hasListeners": "() => any",
        "dispatch": "() => any"
      },
      "QUOTA_BYTES": 102400,
      "QUOTA_BYTES_PER_ITEM": 8192,
      "MAX_ITEMS": 512,
      "MAX_WRITE_OPERATIONS_PER_HOUR": 1800,
      "MAX_WRITE_OPERATIONS_PER_MINUTE": 120,
      "MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE": 1000000
    },
    "managed": {
      "get": "() => any",
      "set": "() => any",
      "remove": "() => any",
      "clear": "() => any",
      "getBytesInUse": "() => any",
      "onChanged": {
        "addListener": "() => any",
        "removeListener": "() => any",
        "hasListener": "() => any",
        "hasListeners": "() => any",
        "dispatch": "() => any"
      }
    },
    "local": {
      "get": "() => any",
      "set": "() => any",
      "remove": "() => any",
      "clear": "() => any",
      "getBytesInUse": "() => any",
      "onChanged": {
        "addListener": "() => any",
        "removeListener": "() => any",
        "hasListener": "() => any",
        "hasListeners": "() => any",
        "dispatch": "() => any"
      },
      "QUOTA_BYTES": 5242880
    },
    "onChanged": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    }
  },
  "system": {
    "cpu": {
      "getInfo": "() => any"
    },
    "display": {
      "onDisplayChanged": {
        "addListener": "() => any",
        "removeListener": "() => any",
        "hasListener": "() => any",
        "hasListeners": "() => any",
        "dispatch": "() => any"
      },
      "clearTouchCalibration": "() => any",
      "completeCustomTouchCalibration": "() => any",
      "enableUnifiedDesktop": "() => any",
      "getDisplayLayout": "() => any",
      "getInfo": "() => any",
      "overscanCalibrationAdjust": "() => any",
      "overscanCalibrationComplete": "() => any",
      "overscanCalibrationReset": "() => any",
      "overscanCalibrationStart": "() => any",
      "setDisplayLayout": "() => any",
      "setDisplayProperties": "() => any",
      "setMirrorMode": "() => any",
      "showNativeTouchCalibration": "() => any",
      "startCustomTouchCalibration": "() => any",
      "LayoutPosition": {
        "BOTTOM": "bottom",
        "LEFT": "left",
        "RIGHT": "right",
        "TOP": "top"
      },
      "MirrorMode": {
        "MIXED": "mixed",
        "NORMAL": "normal",
        "OFF": "off"
      }
    },
    "memory": {
      "getInfo": "() => any"
    },
    "storage": {
      "onDetached": {
        "addListener": "() => any",
        "removeListener": "() => any",
        "hasListener": "() => any",
        "hasListeners": "() => any",
        "dispatch": "() => any"
      },
      "onAttached": {
        "addListener": "() => any",
        "removeListener": "() => any",
        "hasListener": "() => any",
        "hasListeners": "() => any",
        "dispatch": "() => any"
      },
      "ejectDevice": "() => any",
      "getAvailableCapacity": "() => any",
      "getInfo": "() => any",
      "EjectDeviceResultCode": {
        "FAILURE": "failure",
        "IN_USE": "in_use",
        "NO_SUCH_DEVICE": "no_such_device",
        "SUCCESS": "success"
      },
      "StorageUnitType": {
        "FIXED": "fixed",
        "REMOVABLE": "removable",
        "UNKNOWN": "unknown"
      }
    }
  },
  "tabs": {
    "executeScript": "() => any",
    "sendMessage": "() => any"
  },
  "webRequest": {
    "onActionIgnored": {
      "addListener": "() => any",
      "removeListener": "() => any",
      "hasListener": "() => any",
      "hasListeners": "() => any",
      "dispatch": "() => any"
    },
    "onErrorOccurred": {},
    "onCompleted": {},
    "onBeforeRedirect": {},
    "onResponseStarted": {},
    "onAuthRequired": {},
    "onHeadersReceived": {},
    "onSendHeaders": {},
    "onBeforeSendHeaders": {},
    "onBeforeRequest": {},
    "handlerBehaviorChanged": "() => any",
    "IgnoredActionType": {
      "AUTH_CREDENTIALS": "auth_credentials",
      "REDIRECT": "redirect",
      "REQUEST_HEADERS": "request_headers",
      "RESPONSE_HEADERS": "response_headers"
    },
    "OnAuthRequiredOptions": {
      "ASYNC_BLOCKING": "asyncBlocking",
      "BLOCKING": "blocking",
      "EXTRA_HEADERS": "extraHeaders",
      "RESPONSE_HEADERS": "responseHeaders"
    },
    "OnBeforeRedirectOptions": {
      "EXTRA_HEADERS": "extraHeaders",
      "RESPONSE_HEADERS": "responseHeaders"
    },
    "OnBeforeRequestOptions": {
      "BLOCKING": "blocking",
      "EXTRA_HEADERS": "extraHeaders",
      "REQUEST_BODY": "requestBody"
    },
    "OnBeforeSendHeadersOptions": {
      "BLOCKING": "blocking",
      "EXTRA_HEADERS": "extraHeaders",
      "REQUEST_HEADERS": "requestHeaders"
    },
    "OnCompletedOptions": {
      "EXTRA_HEADERS": "extraHeaders",
      "RESPONSE_HEADERS": "responseHeaders"
    },
    "OnErrorOccurredOptions": {
      "EXTRA_HEADERS": "extraHeaders"
    },
    "OnHeadersReceivedOptions": {
      "BLOCKING": "blocking",
      "EXTRA_HEADERS": "extraHeaders",
      "RESPONSE_HEADERS": "responseHeaders"
    },
    "OnResponseStartedOptions": {
      "EXTRA_HEADERS": "extraHeaders",
      "RESPONSE_HEADERS": "responseHeaders"
    },
    "OnSendHeadersOptions": {
      "EXTRA_HEADERS": "extraHeaders",
      "REQUEST_HEADERS": "requestHeaders"
    },
    "ResourceType": {
      "CSP_REPORT": "csp_report",
      "FONT": "font",
      "IMAGE": "image",
      "MAIN_FRAME": "main_frame",
      "MEDIA": "media",
      "OBJECT": "object",
      "OTHER": "other",
      "PING": "ping",
      "SCRIPT": "script",
      "STYLESHEET": "stylesheet",
      "SUB_FRAME": "sub_frame",
      "WEBSOCKET": "websocket",
      "XMLHTTPREQUEST": "xmlhttprequest"
    },
    "MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES": 20
  }
}