package api
import "github.com/evanw/esbuild/pkg/api"
This API exposes esbuild's two main operations: building and transforming. It's intended for integrating esbuild into other tools as a library.
If you are just trying to run esbuild from Go without the overhead of creating a child process, there is also an API for the command-line interface itself: https://godoc.org/github.com/evanw/esbuild/pkg/cli.
Build API
This function runs an end-to-end build operation. It takes an array of file paths as entry points, parses them and all of their dependencies, and returns the output files to write to the file system. The available options roughly correspond to esbuild's command-line flags.
Example usage:
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) } }
Transform API
This function transforms a string of source code into JavaScript. It can be used to minify JavaScript, convert TypeScript/JSX to JavaScript, or convert newer JavaScript to older JavaScript. The available options roughly correspond to esbuild's command-line flags.
Example usage:
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) }
Index ¶
- func FormatMessages(msgs []Message, opts FormatMessagesOptions) []string
- type BuildOptions
- type BuildResult
- type Charset
- type Engine
- type EngineName
- type EntryPoint
- type Format
- type FormatMessagesOptions
- type JSXMode
- type LegalComments
- type Loader
- type Location
- type LogLevel
- type Message
- type MessageKind
- type Note
- type OnLoadArgs
- type OnLoadOptions
- type OnLoadResult
- type OnResolveArgs
- type OnResolveOptions
- type OnResolveResult
- type OnStartResult
- type OutputFile
- type Platform
- type Plugin
- type PluginBuild
- type ResolveKind
- type ServeOnRequestArgs
- type ServeOptions
- type ServeResult
- type SideEffects
- type SourceMap
- type SourcesContent
- type StderrColor
- type StdinOptions
- type Target
- type TransformOptions
- type TransformResult
- type TreeShaking
- type WatchMode
Functions ¶
func FormatMessages ¶
func FormatMessages(msgs []Message, opts FormatMessagesOptions) []string
Types ¶
type BuildOptions ¶
type BuildOptions struct { Color StderrColor LogLimit int LogLevel LogLevel Sourcemap SourceMap SourceRoot string SourcesContent SourcesContent Target Target Engines []Engine MinifyWhitespace bool MinifyIdentifiers bool MinifySyntax bool Charset Charset TreeShaking TreeShaking LegalComments LegalComments JSXMode JSXMode JSXFactory string JSXFragment string Define map[string]string Pure []string KeepNames bool GlobalName string Bundle bool PreserveSymlinks bool Splitting bool Outfile string Metafile bool Outdir string Outbase string AbsWorkingDir string Platform Platform Format Format External []string MainFields []string Conditions []string // For the "exports" field in "package.json" Loader map[string]Loader ResolveExtensions []string Tsconfig string OutExtensions map[string]string PublicPath string Inject []string Banner map[string]string map[string]string NodePaths []string // The "NODE_PATH" variable from Node.js EntryNames string ChunkNames string AssetNames string EntryPoints []string EntryPointsAdvanced []EntryPoint Stdin *StdinOptions Write bool AllowOverwrite bool Incremental bool Plugins []Plugin Watch *WatchMode }
type BuildResult ¶
type BuildResult struct { Errors []Message Warnings []Message OutputFiles []OutputFile Metafile string Rebuild func() BuildResult // Only when "Incremental: true" Stop func() // Only when "Watch: true" }
func Build ¶
func Build(options BuildOptions) BuildResult
type Charset ¶
type Charset uint8
type Engine ¶
type Engine struct { Name EngineName Version string }
type EngineName ¶
type EngineName uint8
const ( EngineChrome EngineName = iota EngineEdge EngineFirefox EngineIOS EngineNode EngineSafari )
type EntryPoint ¶
type Format ¶
type Format uint8
type FormatMessagesOptions ¶
type FormatMessagesOptions struct { TerminalWidth int Kind MessageKind Color bool }
type JSXMode ¶
type JSXMode uint8
type LegalComments ¶
type LegalComments uint8
const ( LegalCommentsDefault LegalComments = iota LegalCommentsNone LegalCommentsInline LegalCommentsEndOfFile LegalCommentsLinked LegalCommentsExternal )
type Loader ¶
type Loader uint8
const ( LoaderNone Loader = iota LoaderJS LoaderJSX LoaderTS LoaderTSX LoaderJSON LoaderText LoaderBase64 LoaderDataURL LoaderFile LoaderBinary LoaderCSS LoaderDefault )
type Location ¶
type Location struct { File string Namespace string Line int // 1-based Column int // 0-based, in bytes Length int // in bytes LineText string Suggestion string }
type LogLevel ¶
type LogLevel uint8
const ( LogLevelSilent LogLevel = iota LogLevelVerbose LogLevelDebug LogLevelInfo LogLevelWarning LogLevelError )
type Message ¶
type Message struct { PluginName string Text string Location *Location Notes []Note // Optional user-specified data that is passed through unmodified. You can // use this to stash the original error, for example. Detail interface{} }
type MessageKind ¶
type MessageKind uint8
const ( ErrorMessage MessageKind = iota WarningMessage )
type Note ¶
type OnLoadArgs ¶
type OnLoadOptions ¶
type OnLoadResult ¶
type OnLoadResult struct { PluginName string Errors []Message Warnings []Message Contents *string ResolveDir string Loader Loader PluginData interface{} WatchFiles []string WatchDirs []string }
type OnResolveArgs ¶
type OnResolveArgs struct { Path string Importer string Namespace string ResolveDir string Kind ResolveKind PluginData interface{} }
type OnResolveOptions ¶
type OnResolveResult ¶
type OnResolveResult struct { PluginName string Errors []Message Warnings []Message Path string External bool SideEffects SideEffects Namespace string PluginData interface{} WatchFiles []string WatchDirs []string }
type OnStartResult ¶
type OutputFile ¶
type Platform ¶
type Platform uint8
type Plugin ¶
type Plugin struct { Name string Setup func(PluginBuild) }
type PluginBuild ¶
type PluginBuild struct { InitialOptions *BuildOptions OnStart func(callback func() (OnStartResult, error)) OnEnd func(callback func(result *BuildResult)) OnResolve func(options OnResolveOptions, callback func(OnResolveArgs) (OnResolveResult, error)) OnLoad func(options OnLoadOptions, callback func(OnLoadArgs) (OnLoadResult, error)) }
type ResolveKind ¶
type ResolveKind uint8
const ( ResolveEntryPoint ResolveKind = iota ResolveJSImportStatement ResolveJSRequireCall ResolveJSDynamicImport ResolveJSRequireResolve ResolveCSSImportRule ResolveCSSURLToken )
type ServeOnRequestArgs ¶
type ServeOnRequestArgs struct { RemoteAddress string Method string Path string Status int TimeInMS int // The time to generate the response, not to send it }
type ServeOptions ¶
type ServeOptions struct { Port uint16 Host string Servedir string OnRequest func(ServeOnRequestArgs) }
type ServeResult ¶
func Serve ¶
func Serve(serveOptions ServeOptions, buildOptions BuildOptions) (ServeResult, error)
type SideEffects ¶
type SideEffects uint8
const ( SideEffectsTrue SideEffects = iota SideEffectsFalse )
type SourceMap ¶
type SourceMap uint8
const ( SourceMapNone SourceMap = iota SourceMapInline SourceMapLinked SourceMapExternal SourceMapInlineAndExternal )
type SourcesContent ¶
type SourcesContent uint8
const ( SourcesContentInclude SourcesContent = iota SourcesContentExclude )
type StderrColor ¶
type StderrColor uint8
const ( ColorIfTerminal StderrColor = iota ColorNever ColorAlways )
type StdinOptions ¶
type Target ¶
type Target uint8
type TransformOptions ¶
type TransformOptions struct { Color StderrColor LogLimit int LogLevel LogLevel Sourcemap SourceMap SourceRoot string SourcesContent SourcesContent Target Target Format Format GlobalName string Engines []Engine MinifyWhitespace bool MinifyIdentifiers bool MinifySyntax bool Charset Charset TreeShaking TreeShaking LegalComments LegalComments JSXMode JSXMode JSXFactory string JSXFragment string TsconfigRaw string string Banner string Define map[string]string Pure []string KeepNames bool Sourcefile string Loader Loader }
type TransformResult ¶
func Transform ¶
func Transform(input string, options TransformOptions) TransformResult
type TreeShaking ¶
type TreeShaking uint8
const ( TreeShakingDefault TreeShaking = iota TreeShakingIgnoreAnnotations )
type WatchMode ¶
type WatchMode struct { OnRebuild func(BuildResult) }
Source Files ¶
api.go api_impl.go serve_other.go
- Version
- v0.12.12
- Published
- Jun 28, 2021
- Platform
- windows/amd64
- Imports
- 29 packages
- Last checked
- 3 minutes ago –
Tools for package owners.