Based on the arguments provided by the CLI to the SDK hook process, returns an appropriate Protocol interface for communicating with the CLI over the specified protocol.

Merges the two given Records, recursively merging any nested Records with the second collection overriding the first in case of conflict

Ensures that the directory exists. If the directory structure does not exist, it is created. Like mkdir -p. Requires the --allow-read and --allow-write flag.

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.

A synchronous version of "analyzeMetafile".

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.

A synchronous version of "build".

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

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.

A synchronous version of "formatMessages".

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.

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.

A synchronous version of "transform".

Take a set of command line arguments, optionally with a set of options, and return an object representing the flags found in the passed arguments.

Converts a JSON with Comments (JSONC) string into an object. If a syntax error is found, throw a SyntaxError.

Determines the common path from a set of paths, using an optional separator, which defaults to the OS default separator.

Convert a glob string to a regular expression.

Test whether the given string is a glob

Like join(), but doesn't collapse "**/.." when globstar is true.

Like normalize(), but doesn't collapse "**/.." when globstar is true.

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

Documentation: https://esbuild.github.io/plugins/#on-load-arguments

Documentation: https://esbuild.github.io/plugins/#on-load-options

Documentation: https://esbuild.github.io/plugins/#on-load-results

Documentation: https://esbuild.github.io/plugins/#on-resolve-arguments

Documentation: https://esbuild.github.io/plugins/#on-resolve-options

Documentation: https://esbuild.github.io/plugins/#on-resolve-results

Documentation: https://esbuild.github.io/plugins/#resolve-options

Documentation: https://esbuild.github.io/plugins/#resolve-results

Documentation: https://esbuild.github.io/api/#serve-arguments

Documentation: https://esbuild.github.io/api/#serve-return-values

A parsed path object generated by path.parse() or consumed by path.format().

An interface encapsulating a specific set of communication rules that both the SDK and the CLI implement.

Valid types as a result of JSON parsing