webext-content-script-ping

One-file interface to detect whether your content script have loaded.

Install

1npm install --save webext-content-script-ping

1import {pingContentScript} from 'webext-content-script-ping';

Usage

From background.js, ping a tab id:

1/* globals pingContentScript */
2pingContentScript(tabId).then(() => {
3	// the content script was loaded!
4}, () => {
5	// the content script was NOT loaded!
6});

Plain files

1. In your manifest.json, include the file as background and as content script:

   1{
   2	"background": {
   3		"scripts": [
   4			"webext-content-script-ping.js"
   5		]
   6	},
   7	"content_scripts": [
   8		{
   9			"js": [
   10				"webext-content-script-ping.js",
   11				"content.js"
   12			]
   13		}
   14	]
   15}

2. In your background script only, run pingContentScript(tabId) as needed

With a bundler

1// background.js
2import pingContentScript from 'webext-content-script-ping';
3pingContentScript(tabId);

1// content.js
2import 'webext-content-script-ping'; // this only responds to the ping

API

pingContentScript(tab)

Returns a Promise that succeeds if the content was loaded, fails if it wasn't.

It has an internal timeout of 300ms.

tab

Type: Tab or number

A Tab object or just its id as defined here: https://developer.chrome.com/extensions/tabs#type-Tab

Related

• webext-options-sync: Helps you manage and autosave your extension's options.
• webext-inject-on-install: Automatically add content scripts to existing tabs when your extension is installed.
• Awesome WebExtensions: A curated list of awesome resources for Web Extensions development.

License

MIT © Federico Brigante — Twitter