mirror of
https://github.com/oven-sh/bun
synced 2026-02-10 02:48:50 +00:00
5424ea3403
* Remove v0.x messages * Add windows section to Installatino * update * update * Update * Comment out windows
31 lines
1.0 KiB
Markdown
31 lines
1.0 KiB
Markdown
Bun provides a universal plugin API that can be used to extend both the _runtime_ and _bundler_.
|
|
|
|
Plugins intercept imports and perform custom loading logic: reading files, transpiling code, etc. They can be used to add support for additional file types, like `.scss` or `.yaml`. In the context of Bun's bundler, plugins can be used to implement framework-level features like CSS extraction, macros, and client-server code co-location.
|
|
|
|
For more complete documentation of the Plugin API, see [Runtime > Plugins](/docs/runtime/plugins).
|
|
|
|
## Usage
|
|
|
|
A plugin is defined as simple JavaScript object containing a `name` property and a `setup` function. Register a plugin with Bun using the `plugin` function.
|
|
|
|
```tsx#myPlugin.ts
|
|
import type { BunPlugin } from "bun";
|
|
|
|
const myPlugin: BunPlugin = {
|
|
name: "Custom loader",
|
|
setup(build) {
|
|
// implementation
|
|
},
|
|
};
|
|
```
|
|
|
|
This plugin can be passed into the `plugins` array when calling `Bun.build`.
|
|
|
|
```ts
|
|
Bun.build({
|
|
entrypoints: ["./app.ts"],
|
|
outdir: "./out",
|
|
plugins: [myPlugin],
|
|
});
|
|
```
|