Interface BuildOptions

interface BuildOptions {
    sourcemap?: boolean | "external" | "linked" | "inline" | "both";
    legalComments?: "external" | "linked" | "inline" | "none" | "eof";
    sourceRoot?: string;
    sourcesContent?: boolean;
    format?: Format;
    globalName?: string;
    target?: string | string[];
    supported?: Record<string, boolean>;
    platform?: Platform;
    mangleProps?: RegExp;
    reserveProps?: RegExp;
    mangleQuoted?: boolean;
    mangleCache?: Record<string, string | false>;
    drop?: Drop[];
    dropLabels?: string[];
    minify?: boolean;
    minifyWhitespace?: boolean;
    minifyIdentifiers?: boolean;
    minifySyntax?: boolean;
    lineLimit?: number;
    charset?: Charset;
    treeShaking?: boolean;
    ignoreAnnotations?: boolean;
    jsx?: "preserve" | "transform" | "automatic";
    jsxFactory?: string;
    jsxFragment?: string;
    jsxImportSource?: string;
    jsxDev?: boolean;
    jsxSideEffects?: boolean;
    define?: { [key: string]: string };
    pure?: string[];
    keepNames?: boolean;
    color?: boolean;
    logLevel?: LogLevel;
    logLimit?: number;
    logOverride?: Record<string, LogLevel>;
    tsconfigRaw?: string | TsconfigRaw;
    bundle?: boolean;
    splitting?: boolean;
    preserveSymlinks?: boolean;
    outfile?: string;
    metafile?: boolean;
    outdir?: string;
    outbase?: string;
    external?: string[];
    packages?: "bundle" | "external";
    alias?: Record<string, string>;
    loader?: { [ext: string]: Loader };
    resolveExtensions?: string[];
    mainFields?: string[];
    conditions?: string[];
    write?: boolean;
    allowOverwrite?: boolean;
    tsconfig?: string;
    outExtension?: { [ext: string]: string };
    publicPath?: string;
    entryNames?: string;
    chunkNames?: string;
    assetNames?: string;
    inject?: string[];
    banner?: { [type: string]: string };
    footer?: { [type: string]: string };
    entryPoints?:
        | string[]
        | Record<string, string>
        | { in: string; out: string }[];
    stdin?: StdinOptions;
    plugins?: Plugin[];
    absWorkingDir?: string;
    nodePaths?: string[];
}

Hierarchy

CommonOptions
- BuildOptions

Properties

`Optional`sourcemap

sourcemap?: boolean | "external" | "linked" | "inline" | "both"

Documentation: https://esbuild.github.io/api/#sourcemap

`Optional`legalComments

legalComments?: "external" | "linked" | "inline" | "none" | "eof"

Documentation: https://esbuild.github.io/api/#legal-comments

`Optional`sourceRoot

sourceRoot?: string

Documentation: https://esbuild.github.io/api/#source-root

`Optional`sourcesContent

sourcesContent?: boolean

Documentation: https://esbuild.github.io/api/#sources-content

`Optional`format

format?: Format

Documentation: https://esbuild.github.io/api/#format

`Optional`globalName

globalName?: string

Documentation: https://esbuild.github.io/api/#global-name

`Optional`target

target?: string | string[]

Documentation: https://esbuild.github.io/api/#target

`Optional`supported

supported?: Record<string, boolean>

Documentation: https://esbuild.github.io/api/#supported

`Optional`platform

platform?: Platform

Documentation: https://esbuild.github.io/api/#platform

`Optional`mangleProps

mangleProps?: RegExp

Documentation: https://esbuild.github.io/api/#mangle-props

`Optional`reserveProps

reserveProps?: RegExp

Documentation: https://esbuild.github.io/api/#mangle-props

`Optional`mangleQuoted

mangleQuoted?: boolean

Documentation: https://esbuild.github.io/api/#mangle-props

`Optional`mangleCache

mangleCache?: Record<string, string | false>

Documentation: https://esbuild.github.io/api/#mangle-props

`Optional`drop

drop?: Drop[]

Documentation: https://esbuild.github.io/api/#drop

`Optional`dropLabels

dropLabels?: string[]

Documentation: https://esbuild.github.io/api/#drop-labels

`Optional`minify

minify?: boolean

Documentation: https://esbuild.github.io/api/#minify

`Optional`minifyWhitespace

minifyWhitespace?: boolean

Documentation: https://esbuild.github.io/api/#minify

`Optional`minifyIdentifiers

minifyIdentifiers?: boolean

Documentation: https://esbuild.github.io/api/#minify

`Optional`minifySyntax

minifySyntax?: boolean

Documentation: https://esbuild.github.io/api/#minify

`Optional`lineLimit

lineLimit?: number

Documentation: https://esbuild.github.io/api/#line-limit

`Optional`charset

charset?: Charset

Documentation: https://esbuild.github.io/api/#charset

`Optional`treeShaking

treeShaking?: boolean

Documentation: https://esbuild.github.io/api/#tree-shaking

`Optional`ignoreAnnotations

ignoreAnnotations?: boolean

Documentation: https://esbuild.github.io/api/#ignore-annotations

`Optional`jsx

jsx?: "preserve" | "transform" | "automatic"

Documentation: https://esbuild.github.io/api/#jsx

`Optional`jsxFactory

jsxFactory?: string

Documentation: https://esbuild.github.io/api/#jsx-factory

`Optional`jsxFragment

jsxFragment?: string

Documentation: https://esbuild.github.io/api/#jsx-fragment

`Optional`jsxImportSource

jsxImportSource?: string

Documentation: https://esbuild.github.io/api/#jsx-import-source

`Optional`jsxDev

jsxDev?: boolean

Documentation: https://esbuild.github.io/api/#jsx-development

`Optional`jsxSideEffects

jsxSideEffects?: boolean

Documentation: https://esbuild.github.io/api/#jsx-side-effects

`Optional`define

define?: { [key: string]: string }

Documentation: https://esbuild.github.io/api/#define

`Optional`pure

pure?: string[]

Documentation: https://esbuild.github.io/api/#pure

`Optional`keepNames

keepNames?: boolean

Documentation: https://esbuild.github.io/api/#keep-names

`Optional`color

color?: boolean

Documentation: https://esbuild.github.io/api/#color

`Optional`logLevel

logLevel?: LogLevel

Documentation: https://esbuild.github.io/api/#log-level

`Optional`logLimit

logLimit?: number

Documentation: https://esbuild.github.io/api/#log-limit

`Optional`logOverride

logOverride?: Record<string, LogLevel>

Documentation: https://esbuild.github.io/api/#log-override

`Optional`tsconfigRaw

tsconfigRaw?: string | TsconfigRaw

Documentation: https://esbuild.github.io/api/#tsconfig-raw

`Optional`bundle

bundle?: boolean

Documentation: https://esbuild.github.io/api/#bundle

`Optional`splitting

splitting?: boolean

Documentation: https://esbuild.github.io/api/#splitting

`Optional`preserveSymlinks

preserveSymlinks?: boolean

Documentation: https://esbuild.github.io/api/#preserve-symlinks

`Optional`outfile

outfile?: string

Documentation: https://esbuild.github.io/api/#outfile

`Optional`metafile

metafile?: boolean

Documentation: https://esbuild.github.io/api/#metafile

`Optional`outdir

outdir?: string

Documentation: https://esbuild.github.io/api/#outdir

`Optional`outbase

outbase?: string

Documentation: https://esbuild.github.io/api/#outbase

`Optional`external

external?: string[]

Documentation: https://esbuild.github.io/api/#external

`Optional`packages

packages?: "bundle" | "external"

Documentation: https://esbuild.github.io/api/#packages

`Optional`alias

alias?: Record<string, string>

Documentation: https://esbuild.github.io/api/#alias

`Optional`loader

loader?: { [ext: string]: Loader }

Documentation: https://esbuild.github.io/api/#loader

`Optional`resolveExtensions

resolveExtensions?: string[]

Documentation: https://esbuild.github.io/api/#resolve-extensions

`Optional`mainFields

mainFields?: string[]

Documentation: https://esbuild.github.io/api/#main-fields

`Optional`conditions

conditions?: string[]

Documentation: https://esbuild.github.io/api/#conditions

`Optional`write

write?: boolean

Documentation: https://esbuild.github.io/api/#write

`Optional`allowOverwrite

allowOverwrite?: boolean

Documentation: https://esbuild.github.io/api/#allow-overwrite

`Optional`tsconfig

tsconfig?: string

Documentation: https://esbuild.github.io/api/#tsconfig

`Optional`outExtension

outExtension?: { [ext: string]: string }

Documentation: https://esbuild.github.io/api/#out-extension

`Optional`publicPath

publicPath?: string

Documentation: https://esbuild.github.io/api/#public-path

`Optional`entryNames

entryNames?: string

Documentation: https://esbuild.github.io/api/#entry-names

`Optional`chunkNames

chunkNames?: string

Documentation: https://esbuild.github.io/api/#chunk-names

`Optional`assetNames

assetNames?: string

Documentation: https://esbuild.github.io/api/#asset-names

`Optional`inject

inject?: string[]

Documentation: https://esbuild.github.io/api/#inject

`Optional`banner

banner?: { [type: string]: string }

Documentation: https://esbuild.github.io/api/#banner

`Optional`footer

footer?: { [type: string]: string }

Documentation: https://esbuild.github.io/api/#footer

`Optional`entryPoints

entryPoints?: string[] | Record<string, string> | { in: string; out: string }[]

Documentation: https://esbuild.github.io/api/#entry-points

`Optional`stdin

stdin?: StdinOptions

Documentation: https://esbuild.github.io/api/#stdin

`Optional`plugins

plugins?: Plugin[]

Documentation: https://esbuild.github.io/plugins/

`Optional`absWorkingDir

absWorkingDir?: string

Documentation: https://esbuild.github.io/api/#working-directory

`Optional`nodePaths

nodePaths?: string[]

Documentation: https://esbuild.github.io/api/#node-paths