@types/webextension-polyfill

What is @types/webextension-polyfill?

@types/webextension-polyfill provides TypeScript type definitions for the webextension-polyfill library, which is a cross-browser polyfill for the WebExtension API. This allows developers to write browser extensions using a consistent API across different browsers, such as Chrome, Firefox, and Edge.

What are @types/webextension-polyfill's main functionalities?

Browser API

This feature allows you to interact with the browser's tabs. The code sample demonstrates how to create a new tab with a specified URL and log the ID of the created tab.

browser.tabs.create({ url: 'https://example.com' }).then((tab) => console.log(`Created tab: ${tab.id}`));

Storage API

This feature provides access to the browser's storage system. The code sample shows how to save data to the local storage and log a confirmation message once the data is saved.

browser.storage.local.set({ key: 'value' }).then(() => console.log('Data saved'));

Runtime API

This feature allows you to handle messages sent to the extension. The code sample demonstrates how to set up a listener for incoming messages and log the received message.

browser.runtime.onMessage.addListener((message) => { console.log(`Received message: ${message}`); });

Other packages similar to @types/webextension-polyfill

webextension-polyfill-ts

webextension-polyfill-ts is a TypeScript-first library that provides type-safe access to the WebExtension API. It is similar to @types/webextension-polyfill in that it offers TypeScript support, but it is specifically designed for TypeScript from the ground up, whereas @types/webextension-polyfill is a type definition package for the existing webextension-polyfill library.

chrome-types

chrome-types provides TypeScript definitions for the Chrome Extensions API. While it is specific to Chrome, it offers comprehensive type definitions for Chrome's extension APIs. In contrast, @types/webextension-polyfill aims to provide a cross-browser solution, making it more versatile for extensions targeting multiple browsers.

README

Installation

npm install --save @types/webextension-polyfill

Summary

This package contains type definitions for webextension-polyfill (https://github.com/mozilla/webextension-polyfill).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/webextension-polyfill.

Additional Details

• Last updated: Thu, 12 Jan 2023 08:32:38 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Santo Pfingsten.