esbuild API

https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api
Admin
esbuild is a fast JavaScript bundler and minifier that provides Go bindings for building and...
Tokens:18,214
Snippets:139
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### Go esbuild Build API Example

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Demonstrates how to use the esbuild Build API in Go to perform an end-to-end build operation. It takes entry points, bundles dependencies, and writes output files. Requires the 'github.com/evanw/esbuild/pkg/api' package.

```go
package main

import (
    "os"

    "github.com/evanw/esbuild/pkg/api"
)

func main() {
    result := api.Build(api.BuildOptions{
        EntryPoints: []string{"input.js"},
        Outfile:     "output.js",
        Bundle:      true,
        Write:       true,
        LogLevel:    api.LogLevelInfo,
    })

    if len(result.Errors) > 0 {
        os.Exit(1)
    }
}

```

--------------------------------

### Go esbuild Transform API Example

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Shows how to use the esbuild Transform API in Go to transform a string of source code into JavaScript. This can be used for minification or transpilation. Requires the 'github.com/evanw/esbuild/pkg/api' package.

```go
package main

import (
    "fmt"
    "os"

    "github.com/evanw/esbuild/pkg/api"
)

func main() {
    jsx := `
        import * as React from 'react'
        import * as ReactDOM from 'react-dom'

        ReactDOM.render(
            <h1>Hello, world!</h1>,
            document.getElementById('root')
        );
    `

    result := api.Transform(jsx, api.TransformOptions{
        Loader: api.LoaderJSX,
    })

    fmt.Printf("%d errors and %d warnings\n",
        len(result.Errors),
        len(result.Warnings))

    os.Stdout.Write(result.Code)
}

```

--------------------------------

### Add Cancel, Dispose, Rebuild, Serve, Watch to BuildContext (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

The BuildContext interface has been expanded with methods for managing the build lifecycle: 'Cancel' to stop a running build, 'Dispose' to clean up resources, 'Rebuild' to trigger a new build, 'Serve' to start a development server, and 'Watch' to enable file watching.

```go
type BuildContext interface {
	Cancel() 
	Dispose() 
	Rebuild() BuildResult 
	Serve(options ServeOptions) (ServeResult, error) 
	Watch(options WatchOptions) error
}
```

--------------------------------

### Go: Define Plugin Structure

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Defines the `Plugin` struct, which is the fundamental unit for extending esbuild's functionality. It contains a name and a `Setup` function.

```go
type Plugin struct {
	Name  string
	Setup func(PluginBuild)
}
```

--------------------------------

### Add Certfile and Keyfile to ServeOptions (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

The ServeOptions struct now includes 'Certfile' and 'Keyfile' string fields. These allow configuring SSL/TLS for the development server by specifying certificate and key files.

```go
type ServeOptions struct {
	Certfile string
	Keyfile string
}
```

--------------------------------

### Serve API

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

The Serve API allows you to run a local development server with live reloading. It takes ServeOptions and BuildOptions to configure the server and the build process.

```APIDOC
## Serve API

### Description
This API starts a local development server that watches for file changes and rebuilds the project. It provides live reloading capabilities.

### Method
`Serve`

### Endpoint
`func Serve(serveOptions ServeOptions, buildOptions BuildOptions) (ServeResult, error)`

### Parameters
#### ServeOptions
- **Host** (string) - The hostname to serve on.
- **Port** (uint16) - The port to serve on.
- **OnRequest** (func(ServeOnRequestArgs)) - A callback function that is called for each request.

#### BuildOptions
- **Incremental** (bool) - Enable incremental compilation.
- **Outbase** (string) - The base directory for output files.
- **Plugins** ([]Plugin) - An array of plugins to use.
- **Define** (map[string]string) - Define global constants.
- **External** ([]string) - An array of paths to exclude from the build.
- **Loader** (map[string]Loader) - Map file extensions to loaders.
- **Pure** ([]string) - An array of symbols that are guaranteed to not have side effects.
- **Banner** (string) - Code to prepend to the output.
- **Footer** (string) - Code to append to the output.
- **KeepNames** (bool) - Keep function and class names.
- **TreeShaking** (TreeShaking) - Controls tree shaking behavior.
- **Charset** (Charset) - The charset to use for the output.
- **AvoidTDZ** (bool) - Avoid the temporal dead zone.
- **Inject** ([]string) - Files to inject into the build.
- **PublicPath** (string) - The public path of the output files.
- **MainFields** ([]string) - Fields to look for in package.json.
- **Write** (bool) - Whether to write output files to disk.
- **OutExtensions** (map[string]string) - Map file extensions to output extensions.
- **SourcesContent** (SourcesContent) - Controls whether to include source content in source maps.

### Request Example
```json
{
  "serveOptions": {
    "Host": "localhost",
    "Port": 8080,
    "OnRequest": null
  },
  "buildOptions": {
    "Incremental": true,
    "Bundle": true,
    "Outdir": "dist"
  }
}
```

### Response
#### Success Response (ServeResult)
- **Port** (uint16) - The port the server is running on.
- **Host** (string) - The host the server is running on.
- **Stop** (func()) - A function to stop the server.
- **Wait** (func() error) - A function to wait for the server to stop.

#### Response Example
```json
{
  "Port": 8080,
  "Host": "localhost",
  "Stop": "<func>",
  "Wait": "<func>"
}
```
```

--------------------------------

### EntryPoint Structure for esbuild

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Defines an entry point for the build process, introduced in v0.11.0. It specifies the input path and the desired output path for an entry point.

```go
type EntryPoint struct {
	InputPath  string
	OutputPath string
}
```

--------------------------------

### Go: Define ServeOptions Structure

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Defines the `ServeOptions` struct, used to configure esbuild's development server. It includes port, host, directory to serve, SSL options, and request handling callbacks.

```go
type ServeOptions struct {
	Port      int
	Host      string
	Servedir  string
	Keyfile   string
	Certfile  string
	Fallback  string
	CORS      CORSOptions
	OnRequest func(ServeOnRequestArgs)
}
```

--------------------------------

### Add AnalyzeMetafile function and options (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

Introduces the AnalyzeMetafile function and AnalyzeMetafileOptions struct. This functionality allows analyzing the build metafile with options for color and verbosity.

```Go
+ func AnalyzeMetafile(metafile string, opts AnalyzeMetafileOptions) string
+ type AnalyzeMetafileOptions struct
+ Color bool
+ Verbose bool
```

--------------------------------

### Build Options

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Configuration options for esbuild builds.

```APIDOC
## Build Options

### Description
Configuration options for esbuild builds, controlling aspects like output format, minification, JSX transformation, and more.

### Method
N/A (This describes a data structure, not an endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
- **Color** (StderrColor) - Controls color output to stderr.
- **LogLevel** (LogLevel) - Controls the verbosity of logs.
- **LogLimit** (int) - Limits the number of log messages.
- **LogOverride** (map[string]LogLevel) - Overrides log levels for specific messages.
- **AbsPaths** (AbsPaths) - Determines if absolute paths are used in output.
- **Sourcemap** (SourceMap) - Controls source map generation.
- **SourceRoot** (string) - Specifies the root directory for source maps.
- **SourcesContent** (SourcesContent) - Controls whether source code content is included in source maps.
- **Target** (Target) - Specifies the JavaScript target environment.
- **Engines** ([]Engine) - Specifies supported JavaScript engines.
- **Supported** (map[string]bool) - Maps supported features to boolean values.
- **MangleProps** (string) - Regular expression to control property name mangling.
- **ReserveProps** (string) - Regular expression to prevent property name mangling.
- **MangleQuoted** (MangleQuoted) - Controls mangling of quoted property names.
- **MangleCache** (map[string]interface{}) - Cache for mangling operations.
- **Drop** (Drop) - Controls which top-level statements to drop.
- **DropLabels** ([]string) - Labels of top-level statements to drop.
- **MinifyWhitespace** (bool) - Enables whitespace minification.
- **MinifyIdentifiers** (bool) - Enables identifier minification.
- **MinifySyntax** (bool) - Enables syntax minification.
- **LineLimit** (int) - Limits the number of lines in output files.
- **Charset** (Charset) - Specifies the character set for output.
- **TreeShaking** (TreeShaking) - Controls tree shaking behavior.
- **IgnoreAnnotations** (bool) - Ignores JSDoc annotations for side effects.
- **LegalComments** (LegalComments) - Controls the inclusion of legal comments.
- **JSX** (JSX) - Specifies the JSX mode.
- **JSXFactory** (string) - Specifies the JSX factory function name.
- **JSXFragment** (string) - Specifies the JSX fragment function name.
- **JSXImportSource** (string) - Specifies the import source for JSX transform.
- **JSXDev** (bool) - Enables JSX transform for development.
- **JSXSideEffects** (bool) - Enables JSX side effects.
- **Define** (map[string]string) - Defines global constants.
- **Pure** ([]string) - Lists functions that are pure and can be removed if unused.
- **KeepNames** (bool) - Prevents renaming of functions and classes.
- **GlobalName** (string) - Specifies the global name for UMD builds.
- **Bundle** (bool) - Enables bundling of all dependencies.
- **PreserveSymlinks** (bool) - Preserves symlinks instead of resolving them.
- **Splitting** (bool) - Enables code splitting.
- **Outfile** (string) - Specifies the output file name.
- **Metafile** (bool) - Generates a metafile with build information.
- **Outdir** (string) - Specifies the output directory.
- **Outbase** (string) - Specifies the base directory for output files.
- **AbsWorkingDir** (string) - Specifies the absolute working directory.
- **Platform** (Platform) - Specifies the target platform.
- **Format** (Format) - Specifies the output format.
- **External** ([]string) - Lists modules to be treated as external.
- **Packages** (Packages) - Specifies package options.
- **Alias** (map[string]string) - Defines module aliases.
- **MainFields** ([]string) - Specifies the main fields to look for in package.json.
- **Conditions** ([]string) - Specifies resolution conditions.
- **Loader** (map[string]Loader) - Maps file extensions to loaders.
- **ResolveExtensions** ([]string) - Specifies file extensions to try when resolving modules.

### Request Example
```json
{
  "Color": "stderrColorAlways",
  "LogLevel": "info",
  "Outfile": "bundle.js",
  "Target": "esnext",
  "MinifyWhitespace": true
}
```

### Response
#### Success Response (200)
N/A (This describes a data structure, not an endpoint response)

#### Response Example
N/A
```

--------------------------------

### Build Lifecycle Callbacks

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Documentation for `OnStartResult`, `OnEndResult`, and `ServeOptions` related to build lifecycle events and serving options.

```APIDOC
## Build Lifecycle Callbacks and Serve Options

### Description
Defines the results for `OnStart` and `OnEnd` callbacks, and options for the development server.

### Types

#### `OnStartResult`

```go
type OnStartResult struct {
	Errors   []Message
	Warnings []Message
}
```

- **Errors** ([]Message): A list of errors that occurred during the start of the build.
- **Warnings** ([]Message): A list of warnings that occurred during the start of the build.

#### `OnEndResult`

```go
type OnEndResult struct {
	Errors   []Message
	Warnings []Message
}
```

- **Errors** ([]Message): A list of errors that occurred during the end of the build.
- **Warnings** ([]Message): A list of warnings that occurred during the end of the build.

#### `ServeOptions`

```go
type ServeOptions struct {
	Port      int
	Host      string
	Servedir  string
	Keyfile   string
	Certfile  string
	Fallback  string
	CORS      CORSOptions
	OnRequest func(ServeOnRequestArgs)
}
```

- **Port** (int): The port to serve on.
- **Host** (string): The host to serve on.
- **Servedir** (string): The directory to serve files from.
- **Keyfile** (string): Path to the SSL key file.
- **Certfile** (string): Path to the SSL certificate file.
- **Fallback** (string): Path to the fallback file for 404s.
- **CORS** (CORSOptions): CORS options for the server.
- **OnRequest** (func(ServeOnRequestArgs)): Callback function for each request received by the server.
```

--------------------------------

### Plugin System Overview

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

This section outlines the core components of the esbuild plugin system, including the `Plugin` type and the `PluginBuild` interface which provides access to esbuild's build process functionalities.

```APIDOC
## Plugin System

### Description
Provides an interface for extending esbuild's build process through custom plugins.

### Types

#### `Plugin`

```go
type Plugin struct {
	Name  string
	Setup func(PluginBuild)
}
```

- **Name** (string): The unique name of the plugin.
- **Setup** (func(PluginBuild)): A function that is called by esbuild to set up the plugin during the build process.

#### `PluginBuild`

```go
type PluginBuild struct {
	// Documentation: https://esbuild.github.io/plugins/#build-options
	InitialOptions *BuildOptions

	// Documentation: https://esbuild.github.io/plugins/#resolve
	Resolve func(path string, options ResolveOptions) ResolveResult

	// Documentation: https://esbuild.github.io/plugins/#on-start
	OnStart func(callback func() (OnStartResult, error))

	// Documentation: https://esbuild.github.io/plugins/#on-end
	OnEnd func(callback func(result *BuildResult) (OnEndResult, error))

	// Documentation: https://esbuild.github.io/plugins/#on-resolve
	OnResolve func(options OnResolveOptions, callback func(OnResolveArgs) (OnResolveResult, error))

	// Documentation: https://esbuild.github.io/plugins/#on-load
	OnLoad func(options OnLoadOptions, callback func(OnLoadArgs) (OnLoadResult, error))

	// Documentation: https://esbuild.github.io/plugins/#on-dispose
	OnDispose func(callback func())
}
```

- **InitialOptions** (*BuildOptions): Access to the initial build options.
- **Resolve** (func(string, ResolveOptions) ResolveResult): Function to resolve module paths.
- **OnStart** (func(func() (OnStartResult, error))): Callback for when the build starts.
- **OnEnd** (func(func(*BuildResult) (OnEndResult, error))): Callback for when the build ends.
- **OnResolve** (func(OnResolveOptions, func(OnResolveArgs) (OnResolveResult, error))): Registers a callback for resolving module paths.
- **OnLoad** (func(OnLoadOptions, func(OnLoadArgs) (OnLoadResult, error))): Registers a callback for loading module content.
- **OnDispose** (func(func())): Callback for when the plugin is disposed.
```

--------------------------------

### Build Function for esbuild

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

The primary function to initiate a build process with esbuild. It accepts BuildOptions as input and returns a BuildResult. This function is the core entry point for programmatically using esbuild.

```go
func Build(options BuildOptions) BuildResult {
}
```

--------------------------------

### Build Options for esbuild

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Defines the configuration options for the esbuild build process. This includes settings for TypeScript compilation, output extensions, public path, injection, banners, footers, entry points, and more. It allows fine-grained control over the bundling and compilation behavior.

```go
type BuildOptions struct {
	Tsconfig          string            // Documentation: https://esbuild.github.io/api/#tsconfig
	TsconfigRaw       string            // Documentation: https://esbuild.github.io/api/#tsconfig-raw
	OutExtension      map[string]string // Documentation: https://esbuild.github.io/api/#out-extension
	PublicPath        string            // Documentation: https://esbuild.github.io/api/#public-path
	Inject            []string          // Documentation: https://esbuild.github.io/api/#inject
	Banner            map[string]string // Documentation: https://esbuild.github.io/api/#banner
	Footer            map[string]string // Documentation: https://esbuild.github.io/api/#footer
	NodePaths         []string          // Documentation: https://esbuild.github.io/api/#node-paths

	EntryNames string // Documentation: https://esbuild.github.io/api/#entry-names
	ChunkNames string // Documentation: https://esbuild.github.io/api/#chunk-names
	AssetNames string // Documentation: https://esbuild.github.io/api/#asset-names

	EntryPoints         []string     // Documentation: https://esbuild.github.io/api/#entry-points
	EntryPointsAdvanced []EntryPoint // Documentation: https://esbuild.github.io/api/#entry-points

	Stdin          *StdinOptions // Documentation: https://esbuild.github.io/api/#stdin
	Write          bool          // Documentation: https://esbuild.github.io/api/#write
	AllowOverwrite bool          // Documentation: https://esbuild.github.io/api/#allow-overwrite
	Plugins        []Plugin      // Documentation: https://esbuild.github.io/plugins/
}
```

--------------------------------

### Add CORSOptions to ServeOptions (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

Introduces CORSOptions to ServeOptions, enabling Cross-Origin Resource Sharing configuration for the development server. This includes an 'Origin' field to specify allowed origins.

```go
type CORSOptions struct {
	Origin []string
}

type ServeOptions struct {
	CORS CORSOptions
}
```

--------------------------------

### Go: Define BuildOptions for esbuild

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

This Go code snippet defines the `BuildOptions` struct used by esbuild. It includes numerous fields for configuring build behavior, such as logging levels, source map generation, target platforms, minification settings, JSX options, and output file configurations. These options allow fine-grained control over the esbuild compilation process.

```go
type BuildOptions struct {
	Color       StderrColor         // Documentation: https://esbuild.github.io/api/#color
	LogLevel    LogLevel            // Documentation: https://esbuild.github.io/api/#log-level
	LogLimit    int                 // Documentation: https://esbuild.github.io/api/#log-limit
	LogOverride map[string]LogLevel // Documentation: https://esbuild.github.io/api/#log-override
	AbsPaths    AbsPaths            // Documentation: https://esbuild.github.io/api/#abs-path

	Sourcemap      SourceMap      // Documentation: https://esbuild.github.io/api/#sourcemap
	SourceRoot     string         // Documentation: https://esbuild.github.io/api/#source-root
	SourcesContent SourcesContent // Documentation: https://esbuild.github.io/api/#sources-content

	Target    Target          // Documentation: https://esbuild.github.io/api/#target
	Engines   []Engine        // Documentation: https://esbuild.github.io/api/#target
	Supported map[string]bool // Documentation: https://esbuild.github.io/api/#supported

	MangleProps       string                 // Documentation: https://esbuild.github.io/api/#mangle-props
	ReserveProps      string                 // Documentation: https://esbuild.github.io/api/#mangle-props
	MangleQuoted      MangleQuoted           // Documentation: https://esbuild.github.io/api/#mangle-props
	MangleCache       map[string]interface{} // Documentation: https://esbuild.github.io/api/#mangle-props
	Drop              Drop                   // Documentation: https://esbuild.github.io/api/#drop
	DropLabels        []string               // Documentation: https://esbuild.github.io/api/#drop-labels
	MinifyWhitespace  bool                   // Documentation: https://esbuild.github.io/api/#minify
	MinifyIdentifiers bool                   // Documentation: https://esbuild.github.io/api/#minify
	MinifySyntax      bool                   // Documentation: https://esbuild.github.io/api/#minify
	LineLimit         int                    // Documentation: https://esbuild.github.io/api/#line-limit
	Charset           Charset                // Documentation: https://esbuild.github.io/api/#charset
	TreeShaking       TreeShaking            // Documentation: https://esbuild.github.io/api/#tree-shaking
	IgnoreAnnotations bool                   // Documentation: https://esbuild.github.io/api/#ignore-annotations
	LegalComments     LegalComments          // Documentation: https://esbuild.github.io/api/#legal-comments

	JSX             JSX    // Documentation: https://esbuild.github.io/api/#jsx-mode
	JSXFactory      string // Documentation: https://esbuild.github.io/api/#jsx-factory
	JSXFragment     string // Documentation: https://esbuild.github.io/api/#jsx-fragment
	JSXImportSource string // Documentation: https://esbuild.github.io/api/#jsx-import-source
	JSXDev          bool   // Documentation: https://esbuild.github.io/api/#jsx-dev
	JSXSideEffects  bool   // Documentation: https://esbuild.github.io/api/#jsx-side-effects

	Define    map[string]string // Documentation: https://esbuild.github.io/api/#define
	Pure      []string          // Documentation: https://esbuild.github.io/api/#pure
	KeepNames bool              // Documentation: https://esbuild.github.io/api/#keep-names

	GlobalName        string            // Documentation: https://esbuild.github.io/api/#global-name
	Bundle            bool              // Documentation: https://esbuild.github.io/api/#bundle
	PreserveSymlinks  bool              // Documentation: https://esbuild.github.io/api/#preserve-symlinks
	Splitting         bool              // Documentation: https://esbuild.github.io/api/#splitting
	Outfile           string            // Documentation: https://esbuild.github.io/api/#outfile
	Metafile          bool              // Documentation: https://esbuild.github.io/api/#metafile
	Outdir            string            // Documentation: https://esbuild.github.io/api/#outdir
	Outbase           string            // Documentation: https://esbuild.github.io/api/#outbase
	AbsWorkingDir     string            // Documentation: https://esbuild.github.io/api/#working-directory
	Platform          Platform          // Documentation: https://esbuild.github.io/api/#platform
	Format            Format            // Documentation: https://esbuild.github.io/api/#format
	External          []string          // Documentation: https://esbuild.github.io/api/#external
	Packages          Packages          // Documentation: https://esbuild.github.io/api/#packages
	Alias             map[string]string // Documentation: https://esbuild.github.io/api/#alias
	MainFields        []string          // Documentation: https://esbuild.github.io/api/#main-fields
	Conditions        []string          // Documentation: https://esbuild.github.io/api/#conditions
	Loader            map[string]Loader // Documentation: https://esbuild.github.io/api/#loader
	ResolveExtensions []string          // Documentation: https://esbuild.github.io/api/#resolve-extensions
}
```

--------------------------------

### Build API

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

The Build API allows you to compile Go code using esbuild. It takes BuildOptions to configure the compilation process.

```APIDOC
## Build API

### Description
This API compiles Go code using esbuild. It supports various options to customize the build process, including output format, code minification, and source map generation.

### Method
`Build`

### Endpoint
`func Build(buildOptions BuildOptions) (BuildResult, error)`

### Parameters
#### BuildOptions
- **Incremental** (bool) - Enable incremental compilation.
- **Outbase** (string) - The base directory for output files.
- **Plugins** ([]Plugin) - An array of plugins to use.
- **Define** (map[string]string) - Define global constants.
- **External** ([]string) - An array of paths to exclude from the build.
- **Loader** (map[string]Loader) - Map file extensions to loaders.
- **Pure** ([]string) - An array of symbols that are guaranteed to not have side effects.
- **Banner** (string) - Code to prepend to the output.
- **Footer** (string) - Code to append to the output.
- **KeepNames** (bool) - Keep function and class names.
- **TreeShaking** (TreeShaking) - Controls tree shaking behavior.
- **Charset** (Charset) - The charset to use for the output.
- **AvoidTDZ** (bool) - Avoid the temporal dead zone.
- **Inject** ([]string) - Files to inject into the build.
- **PublicPath** (string) - The public path of the output files.
- **MainFields** ([]string) - Fields to look for in package.json.
- **Write** (bool) - Whether to write output files to disk.
- **OutExtensions** (map[string]string) - Map file extensions to output extensions.
- **SourcesContent** (SourcesContent) - Controls whether to include source content in source maps.

### Request Example
```json
{
  "buildOptions": {
    "EntryPoints": ["src/index.js"],
    "Outdir": "dist",
    "Bundle": true,
    "Minify": true
  }
}
```

### Response
#### Success Response (BuildResult)
- **Errors** ([]Message) - An array of errors encountered during the build.
- **Warnings** ([]Message) - An array of warnings encountered during the build.
- **OutputFiles** ([]OutputFile) - An array of output files.
- **Rebuild** (func() BuildResult) - A function to trigger a rebuild.

#### Response Example
```json
{
  "Errors": [],
  "Warnings": [],
  "OutputFiles": [
    {
      "Path": "dist/index.js",
      "Contents": "// compiled code",
      "Hash": "abcdef123"
    }
  ],
  "Rebuild": "<func>"
}
```
```

--------------------------------

### Add OutExtension to BuildOptions (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

Introduces the 'OutExtension' field, a map of strings, to BuildOptions. This allows specifying custom output file extensions for different module formats.

```go
type BuildOptions struct {
	OutExtension map[string]string
}
```

--------------------------------

### esbuild StdinOptions Structure

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

The `StdinOptions` struct is used when piping input to esbuild via standard input. It allows specifying the content of the input as a string, the loader to use for processing the input, and the directory to resolve relative paths from. This is useful for integrating esbuild into build pipelines.

```go
package api

type StdinOptions struct {
	Contents string
	Loader   Loader
	ResolveDir string
}
```

--------------------------------

### OnLoad Callbacks

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Documentation for the `OnLoadArgs`, `OnLoadOptions`, and `OnLoadResult` types used in esbuild's `OnLoad` plugin callback.

```APIDOC
## OnLoad Callbacks

### Description
Handles the process of loading the content of a module.

### Types

#### `OnLoadArgs`

```go
type OnLoadArgs struct {
	Path       string
	Namespace  string
	Suffix     string
	PluginData interface{}
	With       map[string]string
}
```

- **Path** (string): The path of the module to load.
- **Namespace** (string): The namespace of the module.
- **Suffix** (string): The suffix of the module path.
- **PluginData** (interface{}): Arbitrary data passed from the `OnResolve` callback.
- **With** (map[string]string): Additional data provided by the caller.

#### `OnLoadOptions`

```go
type OnLoadOptions struct {
	Filter    string
	Namespace string
}
```

- **Filter** (string): A glob pattern to match paths.
- **Namespace** (string): A namespace to filter by.

#### `OnLoadResult`

```go
type OnLoadResult struct {
	PluginName string

	Errors   []Message
	Warnings []Message

	Contents   *string
	ResolveDir string
	Loader     Loader
	PluginData interface{}

	WatchFiles []string
	WatchDirs  []string
}
```

- **PluginName** (string): The name of the plugin that produced this result.
- **Errors** ([]Message): A list of errors encountered during loading.
- **Warnings** ([]Message): A list of warnings encountered during loading.
- **Contents** (*string): The content of the module.
- **ResolveDir** (string): The directory to use for resolving paths within this module.
- **Loader** (Loader): The loader to use for this module.
- **PluginData** (interface{}): Arbitrary data to pass to subsequent plugins.
- **WatchFiles** ([]string): A list of files to watch for changes.
- **WatchDirs** ([]string): A list of directories to watch for changes.
```

--------------------------------

### esbuild Engine Options

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

The `Engine` and `EngineName` types in esbuild allow specifying target JavaScript engines for compatibility checks or specific optimizations. This enables fine-grained control over which browser or runtime environments the bundled code should support, ensuring broader compatibility.

```go
package api

type EngineName uint8

type Engine struct {
	Name    EngineName
	Version string
}

const (
	EngineChrome EngineName
	EngineEdge   EngineName
	EngineFirefox EngineName
	EngineIOS   EngineName
	EngineNode  EngineName
	EngineSafari EngineName
)
```

--------------------------------

### Utility Types

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Documentation for various utility types used within esbuild, including `Note`, `OutputFile`, `Packages`, `Platform`, `ResolveKind`, and `SideEffects`.

```APIDOC
## Utility Types

### Description
Provides definitions for various utility types used across esbuild.

### Types

#### `Note`

```go
type Note struct {
	Text     string
	Location *Location
}
```

- **Text** (string): The text of the note.
- **Location** (*Location): The location associated with the note.

#### `OutputFile`

```go
type OutputFile struct {
	Path     string
	Contents []byte
	Hash     string
}
```

- **Path** (string): The path of the output file.
- **Contents** ([]byte): The content of the output file.
- **Hash** (string): The hash of the output file.

#### `Packages`

```go
type Packages uint8

const (
	PackagesDefault Packages = iota
	PackagesBundle
	PackagesExternal
)
```

- Represents different package handling modes.

#### `Platform`

```go
type Platform uint8

const (
	PlatformDefault Platform = iota
	PlatformBrowser
	PlatformNode
	PlatformNeutral
)
```

- Represents the target platform for the build.

#### `ResolveKind`

```go
type ResolveKind uint8

const (
	ResolveNone ResolveKind = iota
	ResolveEntryPoint
	ResolveJSImportStatement
	ResolveJSRequireCall
	ResolveJSDynamicImport
	ResolveJSRequireResolve
	ResolveCSSImportRule
	ResolveCSSComposesFrom
	ResolveCSSURLToken
)
```

- Represents the kind of resolution being performed.

#### `SideEffects`

- This type is used within `OnResolveResult` and `ResolveResult` but its definition is not provided in the input text. It typically indicates whether a module has side effects.
```

--------------------------------

### Go: Define esbuild WatchOptions

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Defines options for esbuild's watch mode, allowing for file watching and automatic recompilation. The primary option is the delay in milliseconds before triggering a rebuild.

```go
type WatchOptions struct {
	Delay int // In milliseconds
}
```

--------------------------------

### OnResolve Callbacks

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Documentation for the `OnResolveArgs`, `OnResolveOptions`, and `OnResolveResult` types used in esbuild's `OnResolve` plugin callback.

```APIDOC
## OnResolve Callbacks

### Description
Handles the process of resolving module paths within the esbuild build process.

### Types

#### `OnResolveArgs`

```go
type OnResolveArgs struct {
	Path       string
	Importer   string
	Namespace  string
	ResolveDir string
	Kind       ResolveKind
	PluginData interface{}
	With       map[string]string
}
```

- **Path** (string): The path of the module to resolve.
- **Importer** (string): The path of the file that imported the module.
- **Namespace** (string): The namespace of the import.
- **ResolveDir** (string): The directory to use for resolving the path.
- **Kind** (ResolveKind): The type of import.
- **PluginData** (interface{}): Arbitrary data passed from a previous plugin.
- **With** (map[string]string): Additional data provided by the caller.

#### `OnResolveOptions`

```go
type OnResolveOptions struct {
	Filter    string
	Namespace string
}
```

- **Filter** (string): A glob pattern to match paths.
- **Namespace** (string): A namespace to filter by.

#### `OnResolveResult`

```go
type OnResolveResult struct {
	PluginName string

	Errors   []Message
	Warnings []Message

	Path        string
	External    bool
	SideEffects SideEffects
	Namespace   string
	Suffix      string
	PluginData  interface{}

	WatchFiles []string
	WatchDirs  []string
}
```

- **PluginName** (string): The name of the plugin that produced this result.
- **Errors** ([]Message): A list of errors encountered during resolution.
- **Warnings** ([]Message): A list of warnings encountered during resolution.
- **Path** (string): The resolved path of the module.
- **External** (bool): Whether the module should be treated as external.
- **SideEffects** (SideEffects): Indicates whether the module has side effects.
- **Namespace** (string): The namespace of the resolved module.
- **Suffix** (string): A suffix to append to the resolved path.
- **PluginData** (interface{}): Arbitrary data to pass to the next plugin.
- **WatchFiles** ([]string): A list of files to watch for changes.
- **WatchDirs** ([]string): A list of directories to watch for changes.
```

--------------------------------

### Add AbsPaths to BuildOptions and TransformOptions (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

Introduces the AbsPaths type and its constants (CodeAbsPath, LogAbsPath, MetafileAbsPath) to BuildOptions and TransformOptions. This allows for more explicit handling of absolute paths in build and transform configurations.

```go
type AbsPaths uint8

const (
	CodeAbsPath AbsPaths
	LogAbsPath AbsPaths
	MetafileAbsPath AbsPaths
)

type BuildOptions struct {
	AbsPaths AbsPaths
}

type TransformOptions struct {
	AbsPaths AbsPaths
}
```

--------------------------------

### Add With map to OnResolveArgs and ResolveOptions (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

The 'With' field, a map of strings, has been added to both OnResolveArgs and ResolveOptions. This allows for passing arbitrary key-value metadata during the resolution process.

```go
type OnResolveArgs struct {
	With map[string]string
}

type ResolveOptions struct {
	With map[string]string
}
```

--------------------------------

### esbuild Platform Options

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

The `Platform` type in esbuild defines the target environment for the bundled code. It allows specifying whether the output is intended for a browser environment or a Node.js environment. This affects how certain modules and APIs are handled during the bundling process.

```go
package api

type Platform uint8

const (
	PlatformBrowser Platform
	PlatformNode    Platform
)
```

--------------------------------

### BuildContext Interface Definition (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Defines the BuildContext interface for managing esbuild build processes. It includes methods for rebuilding, watching files, serving applications, canceling operations, and disposing of resources.

```go
type BuildContext interface {
	// Documentation: https://esbuild.github.io/api/#rebuild
	Rebuild() BuildResult

	// Documentation: https://esbuild.github.io/api/#watch
	Watch(options WatchOptions) error

	// Documentation: https://esbuild.github.io/api/#serve
	Serve(options ServeOptions) (ServeResult, error)

	Cancel()
	Dispose()
}
```

--------------------------------

### Add Context, ContextError, OnChangeArgs, OnEndResult to API (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

Introduces new types and functions to the esbuild API: 'Context' for creating a build context, 'ContextError' for handling build errors, 'OnChangeArgs' for arguments passed during file changes, and 'OnEndResult' for results after a build completes. Also includes 'Errors' and 'Warnings' fields in OnEndResult.

```go
type ContextError struct {
	Errors []Message
}

func (err *ContextError) Error() string

type OnChangeArgs struct {}

type OnEndResult struct {
	Errors []Message
	Warnings []Message
}

func Context(buildOptions BuildOptions) (BuildContext, *ContextError)

```

--------------------------------

### Add Platform option to TransformOptions (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

Introduces the Platform field to TransformOptions. This allows specifying the target platform for transformations.

```Go
type TransformOptions
+ Platform Platform
```

--------------------------------

### Add PackagesDefault and PackagesExternal to Packages (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

Introduces 'PackagesDefault' and 'PackagesExternal' constants to the 'Packages' type. These likely control how esbuild handles package resolution and bundling.

```go
type Packages uint8

const (
	PackagesDefault Packages
	PackagesExternal Packages
)
```

--------------------------------

### Add OnDispose to PluginBuild (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

The PluginBuild interface now includes an 'OnDispose' method. This allows plugins to register a callback function that will be executed when the build is disposed.

```go
type PluginBuild interface {
	OnDispose(callback func())
}
```

--------------------------------

### Add LineLimit to BuildOptions and TransformOptions (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

Introduces a 'LineLimit' integer field to BuildOptions and TransformOptions. This option likely controls the maximum number of lines in the output code.

```go
type BuildOptions struct {
	LineLimit int
}

type TransformOptions struct {
	LineLimit int
}
```

--------------------------------

### Build Functionality in esbuild

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

The `Build` function in esbuild compiles a JavaScript or TypeScript project into a bundle. It accepts `BuildOptions` to configure the compilation process, including entry points, output format, minification, and more. It returns a `BuildResult` containing output files, errors, and warnings.

```go
package api

type BuildOptions struct {
	Bundle                bool
	Color                 StderrColor
	Defines                 map[string]string
	EntryPoints           []string
	ErrorLimit            int
	Externals             []string
	Format                Format
	GlobalName            string
	JSXFactory            string
	JSXFragment           string
	Loaders               map[string]Loader
	LogLevel              LogLevel
	Metafile              string
	MinifyIdentifiers     bool
	MinifySyntax          bool
	MinifyWhitespace      bool
	Outdir                string
	Outfile               string
	Platform              Platform
	PureFunctions         []string
	ResolveExtensions     []string
	Sourcemap             SourceMap
	Sourcefile            string
	Splitting             bool
	Stdin                 *StdinOptions
	Strict                StrictOptions
	Target                Target
	Tsconfig              string
}

type BuildResult struct {
	Errors      []Message
	OutputFiles []OutputFile
	Warnings    []Message
}

func Build(options BuildOptions) BuildResult
```

--------------------------------

### Go: Define esbuild TransformOptions

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Defines the structure for esbuild's transformation options, allowing customization of compilation, minification, and output settings. It includes options for logging, source maps, target platforms, JSX, TypeScript, and more.

```go
type TransformOptions struct {
	Color       StderrColor         // Documentation: https://esbuild.github.io/api/#color
	LogLevel    LogLevel            // Documentation: https://esbuild.github.io/api/#log-level
	LogLimit    int                 // Documentation: https://esbuild.github.io/api/#log-limit
	LogOverride map[string]LogLevel // Documentation: https://esbuild.github.io/api/#log-override
	AbsPaths    AbsPaths            // Documentation: https://esbuild.github.io/api/#abs-path

	Sourcemap      SourceMap      // Documentation: https://esbuild.github.io/api/#sourcemap
	SourceRoot     string         // Documentation: https://esbuild.github.io/api/#source-root
	SourcesContent SourcesContent // Documentation: https://esbuild.github.io/api/#sources-content

	Target    Target          // Documentation: https://esbuild.github.io/api/#target
	Engines   []Engine        // Documentation: https://esbuild.github.io/api/#target
	Supported map[string]bool // Documentation: https://esbuild.github.io/api/#supported

	Platform   Platform // Documentation: https://esbuild.github.io/api/#platform
	Format     Format   // Documentation: https://esbuild.github.io/api/#format
	GlobalName string   // Documentation: https://esbuild.github.io/api/#global-name

	MangleProps       string                 // Documentation: https://esbuild.github.io/api/#mangle-props
	ReserveProps      string                 // Documentation: https://esbuild.github.io/api/#mangle-props
	MangleQuoted      MangleQuoted           // Documentation: https://esbuild.github.io/api/#mangle-props
	MangleCache       map[string]interface{} // Documentation: https://esbuild.github.io/api/#mangle-props
	Drop              Drop                   // Documentation: https://esbuild.github.io/api/#drop
	DropLabels        []string               // Documentation: https://esbuild.github.io/api/#drop-labels
	MinifyWhitespace  bool                   // Documentation: https://esbuild.github.io/api/#minify
	MinifyIdentifiers bool                   // Documentation: https://esbuild.github.io/api/#minify
	MinifySyntax      bool                   // Documentation: https://esbuild.github.io/api/#minify
	LineLimit         int                    // Documentation: https://esbuild.github.io/api/#line-limit
	Charset           Charset                // Documentation: https://esbuild.github.io/api/#charset
	TreeShaking       TreeShaking            // Documentation: https://esbuild.github.io/api/#tree-shaking
	IgnoreAnnotations bool                   // Documentation: https://esbuild.github.io/api/#ignore-annotations
	LegalComments     LegalComments          // Documentation: https://esbuild.github.io/api/#legal-comments

	JSX             JSX    // Documentation: https://esbuild.github.io/api/#jsx
	JSXFactory      string // Documentation: https://esbuild.github.io/api/#jsx-factory
	JSXFragment     string // Documentation: https://esbuild.github.io/api/#jsx-fragment
	JSXImportSource string // Documentation: https://esbuild.github.io/api/#jsx-import-source
	JSXDev          bool   // Documentation: https://esbuild.github.io/api/#jsx-dev
	JSXSideEffects  bool   // Documentation: https://esbuild.github.io/api/#jsx-side-effects

	TsconfigRaw string // Documentation: https://esbuild.github.io/api/#tsconfig-raw
	Banner      string // Documentation: https://esbuild.github.io/api/#banner
	Footer      string // Documentation: https://esbuild.github.io/api/#footer

	Define    map[string]string // Documentation: https://esbuild.github.io/api/#define
	Pure      []string          // Documentation: https://esbuild.github.io/api/#pure
	KeepNames bool              // Documentation: https://esbuild.github.io/api/#keep-names

	Sourcefile string // Documentation: https://esbuild.github.io/api/#sourcefile
	Loader     Loader // Documentation: https://esbuild.github.io/api/#loader
}
```

--------------------------------

### Add Fallback string to ServeOptions (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

Adds a 'Fallback' string field to ServeOptions. This allows specifying a fallback file to serve when a requested path is not found.

```go
type ServeOptions struct {
	Fallback string
}
```

--------------------------------

### Add PlatformDefault constant to Platform type (Go)

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

Introduces the PlatformDefault constant to the Platform type. This suggests a default platform setting for build or transform operations.

```Go
type Platform
+ const PlatformDefault
```

--------------------------------

### Go: Define OnStartResult Structure

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Defines the `OnStartResult` struct, used to report errors and warnings that occur during the esbuild `OnStart` phase. It provides feedback on the initialization process.

```go
type OnStartResult struct {
	Errors   []Message
	Warnings []Message
}
```

--------------------------------

### esbuild Format Options

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api_tab=versions

The `Format` type in esbuild specifies the module format for the bundled output. It supports various formats like CommonJS, ES modules, and IIFE, allowing developers to choose the most suitable format for their target environment. The default format is typically ES modules.

```go
package api

type Format uint8

const (
	FormatDefault    Format
	FormatCommonJS   Format
	FormatESModule   Format
	FormatIIFE       Format
)
```

--------------------------------

### Go: Define PluginBuild Structure

Source: https://pkg.go.dev/github.com/evanw/esbuild@v0.27.2/pkg/api/github.com/evanw/esbuild%40v0.27.2/pkg/api

Defines the `PluginBuild` struct, providing methods and information to plugins during the build process. It includes access to build options, resolution, and various event callbacks.

```go
type PluginBuild struct {
	// Documentation: https://esbuild.github.io/plugins/#build-options
	InitialOptions *BuildOptions

	// Documentation: https://esbuild.github.io/plugins/#resolve
	Resolve func(path string, options ResolveOptions) ResolveResult

	// Documentation: https://esbuild.github.io/plugins/#on-start
	OnStart func(callback func() (OnStartResult, error))

	// Documentation: https://esbuild.github.io/plugins/#on-end
	OnEnd func(callback func(result *BuildResult) (OnEndResult, error))

	// Documentation: https://esbuild.github.io/plugins/#on-resolve
	OnResolve func(options OnResolveOptions, callback func(OnResolveArgs) (OnResolveResult, error))

	// Documentation: https://esbuild.github.io/plugins/#on-load
	OnLoad func(options OnLoadOptions, callback func(OnLoadArgs) (OnLoadResult, error))

	// Documentation: https://esbuild.github.io/plugins/#on-dispose
	OnDispose func(callback func())
}
```
Tokens:
Raw