Package io.github.cdklabs.projen.javascript

Class AddBundleOptions.Builder

java.lang.Object

io.github.cdklabs.projen.javascript.AddBundleOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AddBundleOptions>

Enclosing interface:

AddBundleOptions

@Stability(Experimental)
public static final class AddBundleOptions.Builder
extends Object
implements software.amazon.jsii.Builder<AddBundleOptions>

A builder for AddBundleOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AddBundleOptions	build()	Builds the configured instance.
AddBundleOptions.Builder	executable(Boolean executable)	Sets the value of AddBundleOptions.getExecutable()
AddBundleOptions.Builder	externals(List<String> externals)	Sets the value of BundlingOptions.getExternals()
AddBundleOptions.Builder	format(String format)	Sets the value of AddBundleOptions.getFormat()
AddBundleOptions.Builder	loaders(Map<String,String> loaders)	Sets the value of AddBundleOptions.getLoaders()
AddBundleOptions.Builder	outfile(String outfile)	Sets the value of AddBundleOptions.getOutfile()
AddBundleOptions.Builder	platform(String platform)	Sets the value of AddBundleOptions.getPlatform()
AddBundleOptions.Builder	sourcemap(Boolean sourcemap)	Sets the value of BundlingOptions.getSourcemap()
AddBundleOptions.Builder	target(String target)	Sets the value of AddBundleOptions.getTarget()
AddBundleOptions.Builder	tsconfigPath(String tsconfigPath)	Sets the value of AddBundleOptions.getTsconfigPath()
AddBundleOptions.Builder	watchTask(Boolean watchTask)	Sets the value of BundlingOptions.getWatchTask()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

platform

@Stability(Experimental)
public AddBundleOptions.Builder platform(String platform)

Sets the value of AddBundleOptions.getPlatform()

Parameters:

platform - esbuild platform. This parameter is required.

Returns:

this

target

@Stability(Experimental)
public AddBundleOptions.Builder target(String target)

Sets the value of AddBundleOptions.getTarget()

Parameters:

target - esbuild target. This parameter is required.

Returns:

this

executable

@Stability(Experimental)
public AddBundleOptions.Builder executable(Boolean executable)

Sets the value of AddBundleOptions.getExecutable()

Parameters:

executable - Mark the output file as executable.

Returns:

this

format

@Stability(Experimental)
public AddBundleOptions.Builder format(String format)

Sets the value of AddBundleOptions.getFormat()

Parameters:

format - Output format for the generated JavaScript files. There are currently three possible values that can be configured: "iife", "cjs", and "esm".

If not set (undefined), esbuild picks an output format for you based on platform:

• "cjs" if platform is "node"
• "iife" if platform is "browser"
• "esm" if platform is "neutral"

Note: If making a bundle to run under node with ESM, set format to "esm" instead of setting platform to "neutral".

Returns:

this

loaders

@Stability(Experimental)
public AddBundleOptions.Builder loaders(Map<String,String> loaders)

Sets the value of AddBundleOptions.getLoaders()

Parameters:

loaders - Map of file extensions (without dot) and loaders to use for this file type. Loaders are appended to the esbuild command by --loader:.extension=loader

Returns:

this

outfile

@Stability(Experimental)
public AddBundleOptions.Builder outfile(String outfile)

Sets the value of AddBundleOptions.getOutfile()

Parameters:

outfile - Bundler output path relative to the asset's output directory.

Returns:

this

tsconfigPath

@Stability(Experimental)
public AddBundleOptions.Builder tsconfigPath(String tsconfigPath)

Sets the value of AddBundleOptions.getTsconfigPath()

Parameters:

tsconfigPath - The path of the tsconfig.json file to use for bundling.

Returns:

this

externals

@Stability(Experimental)
public AddBundleOptions.Builder externals(List<String> externals)

Sets the value of BundlingOptions.getExternals()

Parameters:

externals - You can mark a file or a package as external to exclude it from your build. Instead of being bundled, the import will be preserved (using require for the iife and cjs formats and using import for the esm format) and will be evaluated at run time instead.

This has several uses. First of all, it can be used to trim unnecessary code from your bundle for a code path that you know will never be executed. For example, a package may contain code that only runs in node but you will only be using that package in the browser. It can also be used to import code in node at run time from a package that cannot be bundled. For example, the fsevents package contains a native extension, which esbuild doesn't support.

Returns:

this

sourcemap

@Stability(Experimental)
public AddBundleOptions.Builder sourcemap(Boolean sourcemap)

Sets the value of BundlingOptions.getSourcemap()

Parameters:

sourcemap - Include a source map in the bundle.

Returns:

this

watchTask

@Stability(Experimental)
public AddBundleOptions.Builder watchTask(Boolean watchTask)

Sets the value of BundlingOptions.getWatchTask()

Parameters:

watchTask - In addition to the bundle:xyz task, creates bundle:xyz:watch task which will invoke the same esbuild command with the --watch flag. This can be used to continusouly watch for changes.

Returns:

this

build

@Stability(Experimental)
public AddBundleOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AddBundleOptions>

Returns:

a new instance of AddBundleOptions

Throws:

NullPointerException - if any required attribute was not provided