Skip to content

Commit

Permalink
Completed remaining options
Browse files Browse the repository at this point in the history
  • Loading branch information
porhkz committed Dec 18, 2024
1 parent 45a1742 commit 9e80888
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions packages/esbuild/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# ESbuild
This repository provides a construct which runs the esbuild bundler for AWS through the ILocalBundling interface and allows AWS CDK's bundling process to use the esbuild tool to generate a bundled output
Esbuild is a module bundler and minifier for JavaScript and CSS.

## Overview
This repository provides a construct which runs the esbuild bundler for AWS through the ILocalBundling interface and allows AWS CDK's bundling process to use the esbuild tool to generate a bundled output

## Usage and PrerenderFargateOptions
## Usage and Default esbuild options
### `loglevels` (string)
Options for the level of silence for esbuild warnings and/or error messages to the terminal

Expand Down Expand Up @@ -37,13 +38,17 @@ Default: **false**
### `minify` (booleans)
Generated code will be minified instead of pretty-printed. Downloads faster, but harder to debug. Use minified codes in production but not in development.

`minify` can be broken down into:
- `minifyWhitespace`
- `minifyIdentifiers`
- `minifySyntax`

Default: **false**

`minify` can be broken down into:
- `minifyWhitespace` (boolean)
- Default: **true**
- `minifyIdentifiers` (boolean)
- Do not _minify_ identifiers. Exported 'handler' function name gets minified failing to start the lambda
- Default: **false**
- `minifySyntax` (boolean)
- Default: **true**

### `platform` (string)
Which platform esbuild's bundler will generate code for/

Expand Down

0 comments on commit 9e80888

Please sign in to comment.