Package Exports

@wxt-dev/browser
@wxt-dev/browser/src/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@wxt-dev/browser) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

`@wxt-dev/browser`

Provides access to the browser or chrome extension APIs and related types.

import { browser, Browser } from '@wxt-dev/browser';
// Or if you're using WXT:
// import { browser, Browser } from 'wxt/browser';

console.log(browser.runtime.id);

const onMessage = (message: any, sender: Browser.runtime.MessageSender) => {
  console.log(message);
};
browser.runtime.onMessage.addListener(onMessage);

Installation

If you're using WXT, this package is already installed, you don't need to install it manually.

Otherwise, you can install the package from NPM:

pnpm install @wxt-dev/browser

Upgrading to Latest Types

Just run:

pnpm upgrade @wxt-dev/browser

This should update both the manually installed version and the subdependency inside WXT.

Contributing

Code Generation

Types are generated based on the @types/chrome package, and with modifications specifically for use with WXT.

Updating `@types/chrome` Version

You don't need to do anything! A github action is ran every day to generate and publish this package using the latest @types/chrome version.

You can manually generate types via:

pnpm gen

Why not just use `@types/chrome`?

With WXT, you must import the browser variable to use the extension APIs. The way @types/chrome is implemented forces you to define a global chrome variable. With WXT, this isn't acceptable, we don't want to pollute the global (type) scope or introduce conflicts with auto-imports.

Additionally, WXT overrides types to provide additional type safety for some APIs, like browser.runtime.getURL and browser.i18n.getMessage. With @types/chrome's nested namespace approach, it's not possible to override the types for those functions.

@wxt-dev/browser