Package io.github.cdklabs.projen.javascript

Interface AddBundleOptions

All Superinterfaces:

BundlingOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AddBundleOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-01-10T23:18:45.494Z")
@Stability(Experimental)
public interface AddBundleOptions
extends software.amazon.jsii.JsiiSerializable, BundlingOptions

(experimental) Options for addBundle().

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AddBundleOptions.Builder	A builder for AddBundleOptions
static class	AddBundleOptions.Jsii$Proxy	An implementation for AddBundleOptions

Method Summary

Modifier and Type	Method	Description
static AddBundleOptions.Builder	builder()
default Boolean	getExecutable()	(experimental) Mark the output file as executable.
default String	getFormat()	(experimental) Output format for the generated JavaScript files.
default Map<String,String>	getLoaders()	(experimental) Map of file extensions (without dot) and loaders to use for this file type.
default String	getOutfile()	(experimental) Bundler output path relative to the asset's output directory.
String	getPlatform()	(experimental) esbuild platform.
String	getTarget()	(experimental) esbuild target.
default String	getTsconfigPath()	(experimental) The path of the tsconfig.json file to use for bundling.

Methods inherited from interface io.github.cdklabs.projen.javascript.BundlingOptions

getExternals, getSourcemap, getWatchTask

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPlatform

@Stability(Experimental)
@NotNull
String getPlatform()

(experimental) esbuild platform.

Example:

 "node"
 

getTarget

@Stability(Experimental)
@NotNull
String getTarget()

(experimental) esbuild target.

Example:

 "node12"
 

getExecutable

@Stability(Experimental)
@Nullable
default Boolean getExecutable()

(experimental) Mark the output file as executable.

Default: false

getFormat

@Stability(Experimental)
@Nullable
default String getFormat()

(experimental) 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".

Default: undefined

See Also:

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

getLoaders

@Stability(Experimental)
@Nullable
default Map<String,String> getLoaders()

(experimental) 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

getOutfile

@Stability(Experimental)
@Nullable
default String getOutfile()

(experimental) Bundler output path relative to the asset's output directory.

Default: "index.js"

getTsconfigPath

@Stability(Experimental)
@Nullable
default String getTsconfigPath()

(experimental) The path of the tsconfig.json file to use for bundling.

Default: "tsconfig.json"

builder

@Stability(Experimental)
static AddBundleOptions.Builder builder()

Returns:

a AddBundleOptions.Builder of AddBundleOptions