Skip to content

scripting.md

Latest commit

 

History

History
124 lines (84 loc) · 3.38 KB

scripting.md

File metadata and controls

124 lines (84 loc) · 3.38 KB
Raw

scripting

Documentation: Chrome Scripting API

A promise-based wrapper for the Chrome scripting API to inject scripts and styles, and manage content scripts.

Methods

executeScript

executeScript<T = any>(
  injection: chrome.scripting.ScriptInjection<any, T>
): Promise<chrome.scripting.InjectionResult<chrome.scripting.Awaited<T>>[]>

Executes a script in the specified target and returns the injection results.

getRegisteredContentScripts

getRegisteredContentScripts(
  filter?: chrome.scripting.ContentScriptFilter
): Promise<chrome.scripting.RegisteredContentScript[]>

Retrieves registered content scripts, optionally filtered by criteria.

insertCss

insertCss(injection: chrome.scripting.CSSInjection): Promise<void>

Injects CSS into specified target pages.

registerContentScripts

registerContentScripts(
  scripts: chrome.scripting.RegisteredContentScript[]
): Promise<void>

Registers one or more content scripts programmatically.

removeCss

removeCss(injection: chrome.scripting.CSSInjection): Promise<void>

Removes previously injected CSS from specified target pages.

unregisterContentScripts

unregisterContentScripts(
  filter?: chrome.scripting.ContentScriptFilter
): Promise<void>

Unregisters content scripts matching the given filter.

updateContentScripts

updateContentScripts(
  scripts: chrome.scripting.RegisteredContentScript[]
): Promise<void>

Updates existing content scripts with new definitions.

isAvailableScripting

isAvailableScripting(method?: ApiMethodName<typeof chrome.scripting>): boolean

The optional method is a native function name, for example isAvailableScripting("executeScript"). Import the public ApiMethodName type from @addon-core/browser for your own typed helpers. This checks callable presence without invoking the method; permissions and argument support still require handling.

Returns true when the scripting namespace is present on the API selected by browser() in the current context. Returns false if the namespace or WebExtension environment is absent, or if accessing it throws. The check is synchronous, does not log, and reads the current API on every call without caching. Without an argument, it checks namespace presence only. Pass a native method name to also check that it is callable. Neither form verifies permissions, argument support, or a successful operation. See method availability.

import {isAvailableScripting} from "@addon-core/browser";

if (isAvailableScripting()) {
    // The namespace is present; handle operation-specific failures when using it.
}