type

BuildConfig

type BuildConfig = CompileBuildConfig | NormalBuildConfig

Referenced types

interface CompileBuildConfig

banner?: string
Add a banner to the bundled code such as "use client";
bytecode?: boolean
Generate bytecode for the output. This can dramatically improve cold start times, but will make the final output larger and slightly increase memory usage.
Bytecode is currently only supported for CommonJS (format: "cjs").
Must be target: "bun"
compile: boolean | CompileBuildOptions | Target
Create a standalone executable
When true, creates an executable for the current platform. When a target string, creates an executable for that platform.
// Create executable for current platform await Bun.build({ entrypoints: ['./app.js'], compile: { target: 'linux-x64', }, outfile: './my-app' }); // Cross-compile for Linux x64 await Bun.build({ entrypoints: ['./app.js'], compile: 'linux-x64', outfile: './my-app' });
conditions?: string | string[]
package.json exports conditions used when resolving imports
Equivalent to --conditions in bun build or bun run.
https://nodejs.org/api/packages.html#exports
define?: Record<string, string>
drop?: string[]
Drop function calls to matching property accesses.
emitDCEAnnotations?: boolean
Force emitting @PURE annotations even if minify.whitespace is true.
entrypoints: string[]
List of entrypoints, usually file paths
env?: 'inline' | 'disable' | `${string}*`
Controls how environment variables are handled during bundling.
Can be one of:
"inline": Injects environment variables into the bundled output by converting process.env.FOO references to string literals containing the actual environment variable values
"disable": Disables environment variable injection entirely
A string ending in *: Inlines environment variables that match the given prefix. For example, "MY_PUBLIC_*" will only include env vars starting with "MY_PUBLIC_"
Bun.build({ env: "MY_PUBLIC_*", entrypoints: ["src/index.ts"], })
external?: string[]
footer?: string
Add a footer to the bundled code such as a comment block like
// made with bun!
format?: 'esm' | 'cjs' | 'iife'
Output module format. Top-level await is only supported for "esm".
Can be:
"esm"
"cjs" (experimental)
"iife" (experimental)
ignoreDCEAnnotations?: boolean
Ignore dead code elimination/tree-shaking annotations such as @PURE and package.json "sideEffects" fields. This should only be used as a temporary workaround for incorrect annotations in libraries.
jsx?: { development: boolean; factory: string; fragment: string; importSource: string; runtime: 'classic' | 'automatic'; sideEffects: boolean }
JSX configuration options
loader?: {
__index[
key: string
]: Loader;
}
minify?: boolean | { identifiers: boolean; keepNames: boolean; syntax: boolean; whitespace: boolean }
Whether to enable minification.
Use true/false to enable/disable all minification options. Alternatively, you can pass an object for granular control over certain minifications.
naming?: string | { asset: string; chunk: string; entry: string }
outdir?: string
packages?: 'external' | 'bundle'
plugins?: BunPlugin[]
publicPath?: string
root?: string
sourcemap?: boolean | 'none' | 'linked' | 'external' | 'inline'
Specifies if and how to generate source maps.
"none" - No source maps are generated
"linked" - A separate *.ext.map file is generated alongside each *.ext file. A //# sourceMappingURL comment is added to the output file to link the two. Requires outdir to be set.
"inline" - an inline source map is appended to the output file.
"external" - Generate a separate source map file for each input file. No //# sourceMappingURL comment is added to the output file.
true and false are aliases for "inline" and "none", respectively.
splitting?: undefined
Splitting is not currently supported with .compile
target?: Target
throw?: boolean
When set to true, the returned promise rejects with an AggregateError when a build failure happens.
When set to false, returns a BuildOutput with {success: false}
tsconfig?: string
Custom tsconfig.json file path to use for path resolution. Equivalent to --tsconfig-override in the CLI.
await Bun.build({ entrypoints: ['./src/index.ts'], tsconfig: './custom-tsconfig.json' });

interface NormalBuildConfig

banner?: string
Add a banner to the bundled code such as "use client";
bytecode?: boolean
Generate bytecode for the output. This can dramatically improve cold start times, but will make the final output larger and slightly increase memory usage.
Bytecode is currently only supported for CommonJS (format: "cjs").
Must be target: "bun"
conditions?: string | string[]
package.json exports conditions used when resolving imports
Equivalent to --conditions in bun build or bun run.
https://nodejs.org/api/packages.html#exports
define?: Record<string, string>
drop?: string[]
Drop function calls to matching property accesses.
emitDCEAnnotations?: boolean
Force emitting @PURE annotations even if minify.whitespace is true.
entrypoints: string[]
List of entrypoints, usually file paths
env?: 'inline' | 'disable' | `${string}*`
Controls how environment variables are handled during bundling.
Can be one of:
"inline": Injects environment variables into the bundled output by converting process.env.FOO references to string literals containing the actual environment variable values
"disable": Disables environment variable injection entirely
A string ending in *: Inlines environment variables that match the given prefix. For example, "MY_PUBLIC_*" will only include env vars starting with "MY_PUBLIC_"
Bun.build({ env: "MY_PUBLIC_*", entrypoints: ["src/index.ts"], })
external?: string[]
footer?: string
Add a footer to the bundled code such as a comment block like
// made with bun!
format?: 'esm' | 'cjs' | 'iife'
Output module format. Top-level await is only supported for "esm".
Can be:
"esm"
"cjs" (experimental)
"iife" (experimental)
ignoreDCEAnnotations?: boolean
Ignore dead code elimination/tree-shaking annotations such as @PURE and package.json "sideEffects" fields. This should only be used as a temporary workaround for incorrect annotations in libraries.
jsx?: { development: boolean; factory: string; fragment: string; importSource: string; runtime: 'classic' | 'automatic'; sideEffects: boolean }
JSX configuration options
loader?: {
__index[
key: string
]: Loader;
}
minify?: boolean | { identifiers: boolean; keepNames: boolean; syntax: boolean; whitespace: boolean }
Whether to enable minification.
Use true/false to enable/disable all minification options. Alternatively, you can pass an object for granular control over certain minifications.
naming?: string | { asset: string; chunk: string; entry: string }
outdir?: string
packages?: 'external' | 'bundle'
plugins?: BunPlugin[]
publicPath?: string
root?: string
sourcemap?: boolean | 'none' | 'linked' | 'external' | 'inline'
Specifies if and how to generate source maps.
"none" - No source maps are generated
"linked" - A separate *.ext.map file is generated alongside each *.ext file. A //# sourceMappingURL comment is added to the output file to link the two. Requires outdir to be set.
"inline" - an inline source map is appended to the output file.
"external" - Generate a separate source map file for each input file. No //# sourceMappingURL comment is added to the output file.
true and false are aliases for "inline" and "none", respectively.
splitting?: boolean
Enable code splitting
This does not currently work with compile
target?: Target
throw?: boolean
When set to true, the returned promise rejects with an AggregateError when a build failure happens.
When set to false, returns a BuildOutput with {success: false}
tsconfig?: string
Custom tsconfig.json file path to use for path resolution. Equivalent to --tsconfig-override in the CLI.
await Bun.build({ entrypoints: ['./src/index.ts'], tsconfig: './custom-tsconfig.json' });