BundlingOptions

All Known Implementing Classes:: BundlingOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:54.873Z")
public interface BundlingOptions

Bundling options.

Example:

 NodejsFunction.Builder.create(this, "my-handler")
         .bundling(BundlingOptions.builder()
                 .dockerImage(DockerImage.fromBuild("/path/to/Dockerfile"))
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`BundlingOptions.Builder` A builder for `BundlingOptions`
`static class`	`BundlingOptions.Jsii$Proxy` An implementation for `BundlingOptions`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static BundlingOptions.Builder`	`builder()`
`default java.lang.String`	`getAssetHash()` Specify a custom hash for this asset.
`default java.lang.String`	`getBanner()` Use this to insert an arbitrary string at the beginning of generated JavaScript files.
`default java.util.Map<java.lang.String,java.lang.String>`	`getBuildArgs()` Build arguments to pass when building the bundling image.
`default Charset`	`getCharset()` The charset to use for esbuild's output.
`default ICommandHooks`	`getCommandHooks()` Command hooks.
`default java.util.Map<java.lang.String,java.lang.String>`	`getDefine()` Replace global identifiers with constant expressions.
`default DockerImage`	`getDockerImage()` A custom bundling Docker image.
`default java.util.Map<java.lang.String,java.lang.String>`	`getEnvironment()` Environment variables defined when bundling runs.
`default java.util.Map<java.lang.String,java.lang.Object>`	`getEsbuildArgs()` Build arguments to pass into esbuild.
`default java.lang.String`	`getEsbuildVersion()` The version of esbuild to use when running in a Docker container.
`default java.util.List<java.lang.String>`	`getExternalModules()` A list of modules that should be considered as externals (already available in the runtime).
`default java.lang.String`	`getFooter()` Use this to insert an arbitrary string at the end of generated JavaScript files.
`default java.lang.Boolean`	`getForceDockerBundling()` Force bundling in a Docker container even if local bundling is possible.
`default OutputFormat`	`getFormat()` Output format for the generated JavaScript files.
`default java.util.List<java.lang.String>`	`getInject()` This option allows you to automatically replace a global variable with an import from another file.
`default java.lang.Boolean`	`getKeepNames()` Whether to preserve the original `name` values even in minified code.
`default java.util.Map<java.lang.String,java.lang.String>`	`getLoader()` Use loaders to change how a given input file is interpreted.
`default LogLevel`	`getLogLevel()` Log level for esbuild.
`default java.util.List<java.lang.String>`	`getMainFields()` How to determine the entry point for modules.
`default java.lang.Boolean`	`getMetafile()` This option tells esbuild to write out a JSON file relative to output directory with metadata about the build.
`default java.lang.Boolean`	`getMinify()` Whether to minify files when bundling.
`default java.util.List<java.lang.String>`	`getNodeModules()` A list of modules that should be installed instead of bundled.
`default java.lang.Boolean`	`getPreCompilation()` Run compilation using tsc before running file through bundling step.
`default java.lang.Boolean`	`getSourceMap()` Whether to include source maps when bundling.
`default SourceMapMode`	`getSourceMapMode()` Source map mode to be used when bundling.
`default java.lang.Boolean`	`getSourcesContent()` Whether to include original source code in source maps when bundling.
`default java.lang.String`	`getTarget()` Target environment for the generated JavaScript code.
`default java.lang.String`	`getTsconfig()` Normally the esbuild automatically discovers `tsconfig.json` files and reads their contents during a build.

- Method Detail
  - getAssetHash
```
default java.lang.String getAssetHash()
```
    Specify a custom hash for this asset.
    For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash.
    NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated.
    Default: - asset hash is calculated based on the bundled output
  - getBanner
```
default java.lang.String getBanner()
```
    Use this to insert an arbitrary string at the beginning of generated JavaScript files.
    This is similar to footer which inserts at the end instead of the beginning.
    This is commonly used to insert comments:
    Default: - no comments are passed
  - getBuildArgs
```
default java.util.Map<java.lang.String,java.lang.String> getBuildArgs()
```
    Build arguments to pass when building the bundling image.
    Default: - no build arguments are passed
  - getCharset
```
default Charset getCharset()
```
    The charset to use for esbuild's output.
    By default esbuild's output is ASCII-only. Any non-ASCII characters are escaped using backslash escape sequences. Using escape sequences makes the generated output slightly bigger, and also makes it harder to read. If you would like for esbuild to print the original characters without using escape sequences, use Charset.UTF8.
    Default: Charset.ASCII
    
    See Also:
    
    https://esbuild.github.io/api/#charset
  - getCommandHooks
```
default ICommandHooks getCommandHooks()
```
    Command hooks.
    Default: - do not run additional commands
  - getDefine
```
default java.util.Map<java.lang.String,java.lang.String> getDefine()
```
    Replace global identifiers with constant expressions.
    For example, { 'process.env.DEBUG': 'true' }.
    Another example, { 'process.env.API_KEY': JSON.stringify('xxx-xxxx-xxx') }.
    Default: - no replacements are made
  - getDockerImage
```
default DockerImage getDockerImage()
```
    A custom bundling Docker image.
    This image should have esbuild installed globally. If you plan to use nodeModules it should also have npm or yarn depending on the lock file you're using.
    See https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/aws-lambda-nodejs/lib/Dockerfile for the default image provided by @aws-cdk/aws-lambda-nodejs.
    Default: - use the Docker image provided by
  - getEnvironment
```
default java.util.Map<java.lang.String,java.lang.String> getEnvironment()
```
    Environment variables defined when bundling runs.
    Default: - no environment variables are defined.
  - getEsbuildArgs
```
default java.util.Map<java.lang.String,java.lang.Object> getEsbuildArgs()
```
    Build arguments to pass into esbuild.
    For example, to add the --log-limit flag:
    new NodejsFunction(scope, id, { ... bundling: { esbuildArgs: { "--log-limit": "0", } } });
    Default: - no additional esbuild arguments are passed
  - getEsbuildVersion
```
default java.lang.String getEsbuildVersion()
```
    The version of esbuild to use when running in a Docker container.
    Default: - latest v0
  - getExternalModules
```
default java.util.List<java.lang.String> getExternalModules()
```
    A list of modules that should be considered as externals (already available in the runtime).
    Default: ['aws-sdk']
  - getFooter
```
default java.lang.String getFooter()
```
    Use this to insert an arbitrary string at the end of generated JavaScript files.
    This is similar to banner which inserts at the beginning instead of the end.
    This is commonly used to insert comments
    Default: - no comments are passed
  - getForceDockerBundling
```
default java.lang.Boolean getForceDockerBundling()
```
    Force bundling in a Docker container even if local bundling is possible.
    This is useful if your function relies on node modules that should be installed (nodeModules) in a Lambda compatible environment.
    Default: false
  - getFormat
```
default OutputFormat getFormat()
```
    Output format for the generated JavaScript files.
    Default: OutputFormat.CJS
  - getInject
```
default java.util.List<java.lang.String> getInject()
```
    This option allows you to automatically replace a global variable with an import from another file.
    Default: - no code is injected
    
    See Also:
    
    https://esbuild.github.io/api/#inject
  - getKeepNames
```
default java.lang.Boolean getKeepNames()
```
    Whether to preserve the original `name` values even in minified code.
    In JavaScript the name property on functions and classes defaults to a nearby identifier in the source code.
    However, minification renames symbols to reduce code size and bundling sometimes need to rename symbols to avoid collisions. That changes value of the name property for many of these cases. This is usually fine because the name property is normally only used for debugging. However, some frameworks rely on the name property for registration and binding purposes. If this is the case, you can enable this option to preserve the original name values even in minified code.
    Default: false
  - getLoader
```
default java.util.Map<java.lang.String,java.lang.String> getLoader()
```
    Use loaders to change how a given input file is interpreted.
    Configuring a loader for a given file type lets you load that file type with an import statement or a require call.
    Default: - use esbuild default loaders
    
    See Also:
    
    https://esbuild.github.io/api/#loader For example, `{ '.png': 'dataurl' }`.
  - getLogLevel
```
default LogLevel getLogLevel()
```
    Log level for esbuild.
    This is also propagated to the package manager and applies to its specific install command.
    Default: LogLevel.WARNING
  - getMainFields
```
default java.util.List<java.lang.String> getMainFields()
```
    How to determine the entry point for modules.
    Try ['module', 'main'] to default to ES module versions.
    Default: ['main', 'module']
  - getMetafile
```
default java.lang.Boolean getMetafile()
```
    This option tells esbuild to write out a JSON file relative to output directory with metadata about the build.
    The metadata in this JSON file follows this schema (specified using TypeScript syntax):
    { outputs: { [path: string]: { bytes: number inputs: { [path: string]: { bytesInOutput: number } } imports: { path: string }[] exports: string[] } } }
    This data can then be analyzed by other tools. For example, bundle buddy can consume esbuild's metadata format and generates a treemap visualization of the modules in your bundle and how much space each one takes up.
    Default: false
    See Also:
    
    https://esbuild.github.io/api/#metafile
  - getMinify
```
default java.lang.Boolean getMinify()
```
    Whether to minify files when bundling.
    Default: false
  - getNodeModules
```
default java.util.List<java.lang.String> getNodeModules()
```
    A list of modules that should be installed instead of bundled.
    Modules are installed in a Lambda compatible environment only when bundling runs in Docker.
    Default: - all modules are bundled
  - getPreCompilation
```
default java.lang.Boolean getPreCompilation()
```
    Run compilation using tsc before running file through bundling step.
    This usually is not required unless you are using new experimental features that are only supported by typescript's tsc compiler. One example of such feature is emitDecoratorMetadata.
    Default: false
  - getSourceMap
```
default java.lang.Boolean getSourceMap()
```
    Whether to include source maps when bundling.
    Default: false
  - getSourceMapMode
```
default SourceMapMode getSourceMapMode()
```
    Source map mode to be used when bundling.
    Default: SourceMapMode.DEFAULT
    
    See Also:
    
    https://esbuild.github.io/api/#sourcemap
  - getSourcesContent
```
default java.lang.Boolean getSourcesContent()
```
    Whether to include original source code in source maps when bundling.
    Default: true
    
    See Also:
    
    https://esbuild.github.io/api/#sources-content
  - getTarget
```
default java.lang.String getTarget()
```
    Target environment for the generated JavaScript code.
    Default: - the node version of the runtime
    
    See Also:
    
    https://esbuild.github.io/api/#target
  - getTsconfig
```
default java.lang.String getTsconfig()
```
    Normally the esbuild automatically discovers `tsconfig.json` files and reads their contents during a build.
    However, you can also configure a custom tsconfig.json file to use instead.
    This is similar to entry path, you need to provide path to your custom tsconfig.json.
    This can be useful if you need to do multiple builds of the same code with different settings.
    For example, { 'tsconfig': 'path/custom.tsconfig.json' }.
    Default: - automatically discovered by `esbuild`
  - builder
```
static BundlingOptions.Builder builder()
```
    Returns:
    
    a BundlingOptions.Builder of BundlingOptions

Interface BundlingOptions

Nested Class Summary

Method Summary

Method Detail

getAssetHash

getBanner

getBuildArgs

getCharset

getCommandHooks

getDefine

getDockerImage

getEnvironment

getEsbuildArgs

getEsbuildVersion

getExternalModules

getFooter

getForceDockerBundling

getFormat

getInject

getKeepNames

getLoader

getLogLevel

getMainFields

getMetafile

getMinify

getNodeModules

getPreCompilation

getSourceMap

getSourceMapMode

getSourcesContent

getTarget

getTsconfig

builder