Interface CommonOptions

interface CommonOptions {
    charset?: Charset;
    color?: boolean;
    define?: {
        [key: string]: string;
    };
    drop?: Drop[];
    dropLabels?: string[];
    format?: Format;
    globalName?: string;
    ignoreAnnotations?: boolean;
    jsx?: "transform" | "preserve" | "automatic";
    jsxDev?: boolean;
    jsxFactory?: string;
    jsxFragment?: string;
    jsxImportSource?: string;
    jsxSideEffects?: boolean;
    keepNames?: boolean;
    legalComments?: "external" | "linked" | "inline" | "none" | "eof";
    lineLimit?: number;
    logLevel?: LogLevel;
    logLimit?: number;
    logOverride?: Record<string, LogLevel>;
    mangleCache?: Record<string, string | false>;
    mangleProps?: RegExp;
    mangleQuoted?: boolean;
    minify?: boolean;
    minifyIdentifiers?: boolean;
    minifySyntax?: boolean;
    minifyWhitespace?: boolean;
    platform?: Platform;
    pure?: string[];
    reserveProps?: RegExp;
    sourceRoot?: string;
    sourcemap?: boolean | "external" | "linked" | "inline" | "both";
    sourcesContent?: boolean;
    supported?: Record<string, boolean>;
    target?: string | string[];
    treeShaking?: boolean;
    tsconfigRaw?: string | TsconfigRaw;
}

Hierarchy (view full)

Properties

charset? color? define? drop? dropLabels? format? globalName? ignoreAnnotations? jsx? jsxDev? jsxFactory? jsxFragment? jsxImportSource? jsxSideEffects? keepNames? legalComments? lineLimit? logLevel? logLimit? logOverride? mangleCache? mangleProps? mangleQuoted? minify? minifyIdentifiers? minifySyntax? minifyWhitespace? platform? pure? reserveProps? sourceRoot? sourcemap? sourcesContent? supported? target? treeShaking? tsconfigRaw?

Properties

Optional charset

charset?: Charset

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

Optional color

color?: boolean

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

Optional define

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

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

Type declaration

  • [key: string]: string

Optional drop

drop?: Drop[]

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

Optional dropLabels

dropLabels?: string[]

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

Optional format

format?: Format

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

Optional globalName

globalName?: string

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

Optional ignoreAnnotations

ignoreAnnotations?: boolean

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

Optional jsx

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

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

Optional jsxDev

jsxDev?: boolean

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

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 jsxSideEffects

jsxSideEffects?: boolean

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

Optional keepNames

keepNames?: boolean

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

Optional legalComments

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

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

Optional lineLimit

lineLimit?: number

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

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 mangleCache

mangleCache?: Record<string, string | false>

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

Optional mangleProps

mangleProps?: RegExp

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

Optional mangleQuoted

mangleQuoted?: boolean

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

Optional minify

minify?: 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 minifyWhitespace

minifyWhitespace?: boolean

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

Optional platform

platform?: Platform

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

Optional pure

pure?: string[]

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

Optional reserveProps

reserveProps?: RegExp

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

Optional sourceRoot

sourceRoot?: string

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

Optional sourcemap

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

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

Optional sourcesContent

sourcesContent?: boolean

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

Optional supported

supported?: Record<string, boolean>

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

Optional target

target?: string | string[]

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

Optional treeShaking

treeShaking?: boolean

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

Optional tsconfigRaw

tsconfigRaw?: string | TsconfigRaw

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

Settings

Member Visibility

Theme

On This Page

charsetcolordefinedropdropLabelsformatglobalNameignoreAnnotationsjsxjsxDevjsxFactoryjsxFragmentjsxImportSourcejsxSideEffectskeepNameslegalCommentslineLimitlogLevellogLimitlogOverridemangleCachemanglePropsmangleQuotedminifyminifyIdentifiersminifySyntaxminifyWhitespaceplatformpurereservePropssourceRootsourcemapsourcesContentsupportedtargettreeShakingtsconfigRaw