Skip to main content

​
Bundle

Creates and manages bundled JavaScript/TypeScript files using esbuild. Supports various output formats, sourcemaps, and platform targets.

​
Properties

​
entryPoint
string
required
Entry point for the bundle. Path to the source file to bundle (e.g., “src/handler.ts”).
​
outdir
string
Output directory for the bundle. Directory where the bundled file will be written.
​
outfile
string
Output filename for the bundle. Full path to the output file, overrides outdir if specified.
​
format
'iife' | 'cjs' | 'esm'
Bundle format:
  • iife: Immediately Invoked Function Expression
  • cjs: CommonJS
  • esm: ECMAScript Modules
​
target
string | string[]
Target environment. Examples: ‘node16’, ‘node18’, ‘es2020’
​
minify
boolean
Whether to minify the output.
​
sourcemap
boolean | 'inline' | 'external' | 'both'
Whether to generate sourcemaps:
  • inline: Include sourcemap in bundle
  • external: Generate separate .map file
  • both: Generate both inline and external
​
external
string[]
External packages to exclude from bundle. Array of package names to mark as external.
​
platform
'browser' | 'node' | 'neutral'
Platform to target:
  • browser: Browser environment
  • node: Node.js environment
  • neutral: Platform-agnostic

​
Returns

​
path
string
Path to the bundled file. Absolute or relative path to the generated bundle.
​
hash
string
SHA-256 hash of the bundle contents. Used for cache busting and content verification.
​
content
string
The content of the bundle (the .js or .mjs file).

​
Examples

​
Bundle a TypeScript file for Node.js

const bundle = await Bundle("handler", {
  entryPoint: "src/handler.ts",
  outdir: ".alchemy/.out",
  format: "esm",
  platform: "node",
  target: "node18"
});

console.log(bundle.path); // Path to the bundled file
console.log(bundle.hash); // SHA-256 hash of the bundle

​
Bundle for browser with minification

const browserBundle = await Bundle("app", {
  entryPoint: "src/app.ts",
  outdir: "dist",
  format: "iife",
  platform: "browser",
  target: "es2020",
  minify: true,
  sourcemap: "external"
});

​
Bundle with external dependencies

const bundle = await Bundle("worker", {
  entryPoint: "src/worker.ts",
  outdir: "dist",
  format: "esm",
  platform: "neutral",
  external: ["react", "react-dom"],
  minify: true
});

Build docs developers (and LLMs) love

Get started for freeTalk to us