Skip to content

Commit 446f265

Browse files
committed
types!: Rename BackgroundScriptDefintition to BackgroundDefinition
1 parent 7a46568 commit 446f265

File tree

5 files changed

+15
-13
lines changed

5 files changed

+15
-13
lines changed

docs/guide/auto-imports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Some WXT APIs can be used without importing them:
1212

1313
- [`browser`](/api/wxt-browser#browser) from `wxt/browser`, a small wrapper around `webextension-polyfill`
1414
- [`defineContentScript`](/api/wxt-client#defiencontentscript) from `wxt/client`
15-
- [`defineBackground`](/api/wxt-client#definebackgroundscript) from `wxt/client`
15+
- [`defineBackground`](/api/wxt-client#definebackground) from `wxt/client`
1616
- [`createContentScriptUi`](/api/wxt-client#createcontentscriptui) from `wxt/client`
1717

1818
And more. All [`wxt/client`](/api/wxt-client) APIs can be used without imports.

src/client/defineBackground.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
import { BackgroundScriptDefintition } from '..';
1+
import { BackgroundDefinition } from '..';
22

3-
export function defineBackground(main: () => void): BackgroundScriptDefintition;
3+
export function defineBackground(main: () => void): BackgroundDefinition;
44
export function defineBackground(
5-
definition: BackgroundScriptDefintition,
6-
): BackgroundScriptDefintition;
5+
definition: BackgroundDefinition,
6+
): BackgroundDefinition;
77
export function defineBackground(
8-
arg: (() => void) | BackgroundScriptDefintition,
9-
): BackgroundScriptDefintition {
8+
arg: (() => void) | BackgroundDefinition,
9+
): BackgroundDefinition {
1010
if (typeof arg === 'function') return { main: arg };
1111
return arg;
1212
}

src/client/virtual-modules/virtual-module-globals.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ declare module '*?raw' {
66
}
77

88
declare module 'virtual:user-background' {
9-
const definition: import('../../').BackgroundScriptDefintition;
9+
const definition: import('../../').BackgroundDefinition;
1010
export default definition;
1111
}
1212

src/core/build/findEntrypoints.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { relative, resolve } from 'path';
22
import {
33
BackgroundEntrypoint,
4-
BackgroundScriptDefintition,
4+
BackgroundDefinition,
55
BaseEntrypointOptions,
66
ContentScriptDefinition,
77
ContentScriptEntrypoint,
@@ -295,10 +295,12 @@ async function getBackgroundEntrypoint(
295295
config: InternalConfig,
296296
path: string,
297297
): Promise<BackgroundEntrypoint> {
298-
let options: Omit<BackgroundScriptDefintition, 'main'> = {};
298+
let options: Omit<BackgroundDefinition, 'main'> = {};
299299
if (path !== VIRTUAL_NOOP_BACKGROUND_MODULE_ID) {
300-
const defaultExport =
301-
await importEntrypointFile<BackgroundScriptDefintition>(path, config);
300+
const defaultExport = await importEntrypointFile<BackgroundDefinition>(
301+
path,
302+
config,
303+
);
302304
if (defaultExport == null) {
303305
throw Error('Background script does not have a default export');
304306
}

src/core/types/external.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ export interface ContentScriptDefinition extends ExcludableEntrypoint {
429429
main(ctx: ContentScriptContext): void | Promise<void>;
430430
}
431431

432-
export interface BackgroundScriptDefintition extends ExcludableEntrypoint {
432+
export interface BackgroundDefinition extends ExcludableEntrypoint {
433433
type?: PerBrowserOption<'module'>;
434434
persistent?: PerBrowserOption<boolean>;
435435
main(): void;

0 commit comments

Comments
 (0)