Interface PluginBuild

Type declaration

• analyzeMetafile: (metafile: string | Metafile, options?: AnalyzeMetafileOptions) => Promise<string>

  • • (metafile: string | Metafile, options?: AnalyzeMetafileOptions): Promise<string>

    • Pretty-prints an analysis of the metafile JSON to a string. This is just for convenience to be able to match esbuild's pretty-printing exactly. If you want to customize it, you can just inspect the data in the metafile yourself.

      • Works in node: yes
      • Works in browser: yes

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

      Parameters

      • metafile: string | Metafile

      • Optional options: AnalyzeMetafileOptions

      Returns Promise<string>

• analyzeMetafileSync: (metafile: string | Metafile, options?: AnalyzeMetafileOptions) => string

  • • (metafile: string | Metafile, options?: AnalyzeMetafileOptions): string

    • A synchronous version of "analyzeMetafile".

      • Works in node: yes
      • Works in browser: no

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

      Parameters

      • metafile: string | Metafile

      • Optional options: AnalyzeMetafileOptions

      Returns string

• build: <T>(options: SameShape<BuildOptions, T>) => Promise<BuildResult<T>>

  • • <T>(options: SameShape<BuildOptions, T>): Promise<BuildResult<T>>

    • This function invokes the "esbuild" command-line tool for you. It returns a promise that either resolves with a "BuildResult" object or rejects with a "BuildFailure" object.

      • Works in node: yes
      • Works in browser: yes

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

      Type parameters

      • T: BuildOptions

      Parameters

      • options: SameShape<BuildOptions, T>

      Returns Promise<BuildResult<T>>

• buildSync: <T>(options: SameShape<BuildOptions, T>) => BuildResult<T>

  • • <T>(options: SameShape<BuildOptions, T>): BuildResult<T>

    • A synchronous version of "build".

      • Works in node: yes
      • Works in browser: no

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

      Type parameters

      • T: BuildOptions

      Parameters

      • options: SameShape<BuildOptions, T>

      Returns BuildResult<T>

• context: <T>(options: SameShape<BuildOptions, T>) => Promise<BuildContext<T>>

  • • <T>(options: SameShape<BuildOptions, T>): Promise<BuildContext<T>>

    • This is the advanced long-running form of "build" that supports additional features such as watch mode and a local development server.

      • Works in node: yes
      • Works in browser: no

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

      Type parameters

      • T: BuildOptions

      Parameters

      • options: SameShape<BuildOptions, T>

      Returns Promise<BuildContext<T>>

• formatMessages: (messages: PartialMessage[], options: FormatMessagesOptions) => Promise<string[]>

  • • (messages: PartialMessage[], options: FormatMessagesOptions): Promise<string[]>

    • Converts log messages to formatted message strings suitable for printing in the terminal. This allows you to reuse the built-in behavior of esbuild's log message formatter. This is a batch-oriented API for efficiency.

      • Works in node: yes
      • Works in browser: yes

      Parameters

      • messages: PartialMessage[]

      • options: FormatMessagesOptions

      Returns Promise<string[]>

• formatMessagesSync: (messages: PartialMessage[], options: FormatMessagesOptions) => string[]

  • • (messages: PartialMessage[], options: FormatMessagesOptions): string[]

    • A synchronous version of "formatMessages".

      • Works in node: yes
      • Works in browser: no

      Parameters

      • messages: PartialMessage[]

      • options: FormatMessagesOptions

      Returns string[]

• initialize: (options: InitializeOptions) => Promise<void>

  • • (options: InitializeOptions): Promise<void>

    • This configures the browser-based version of esbuild. It is necessary to call this first and wait for the returned promise to be resolved before making other API calls when using esbuild in the browser.

      • Works in node: yes
      • Works in browser: yes ("options" is required)

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

      Parameters

      • options: InitializeOptions

      Returns Promise<void>

• transform: <T>(input: string | Uint8Array, options?: SameShape<TransformOptions, T>) => Promise<TransformResult<T>>

  • • <T>(input: string | Uint8Array, options?: SameShape<TransformOptions, T>): Promise<TransformResult<T>>

    • This function transforms a single JavaScript file. It can be used to minify JavaScript, convert TypeScript/JSX to JavaScript, or convert newer JavaScript to older JavaScript. It returns a promise that is either resolved with a "TransformResult" object or rejected with a "TransformFailure" object.

      • Works in node: yes
      • Works in browser: yes

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

      Type parameters

      • T: TransformOptions

      Parameters

      • input: string | Uint8Array

      • Optional options: SameShape<TransformOptions, T>

      Returns Promise<TransformResult<T>>

• transformSync: <T>(input: string | Uint8Array, options?: SameShape<TransformOptions, T>) => TransformResult<T>

  • • <T>(input: string | Uint8Array, options?: SameShape<TransformOptions, T>): TransformResult<T>

    • A synchronous version of "transform".

      • Works in node: yes
      • Works in browser: no

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

      Type parameters

      • T: TransformOptions

      Parameters

      • input: string | Uint8Array

      • Optional options: SameShape<TransformOptions, T>

      Returns TransformResult<T>

• version: string