@mrgrain/cdk-esbuild 2.0.0-alpha.0 → 2.0.0-alpha.5

package/API.md

@@ -3,6 +3,86 @@
 
 ## Structs <a name="Structs"></a>
 
+### AssetProps <a name="@mrgrain/cdk-esbuild.AssetProps"></a>
+
+#### Initializer <a name="[object Object].Initializer"></a>
+
+```typescript
+import { AssetProps } from '@mrgrain/cdk-esbuild'
+
+const assetProps: AssetProps = { ... }
+```
+
+##### `buildOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.AssetProps.property.buildOptions"></a>
+
+```typescript
+public readonly buildOptions: BuildOptions;
+```
+
+- *Type:* [`@mrgrain/cdk-esbuild.BuildOptions`](#@mrgrain/cdk-esbuild.BuildOptions)
+
+Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.
+
+`buildOptions.outdir: string` \
+The actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \
+For example `{ outdir: 'js' }` will create an asset with a single directory called `js`, which contains all built files. This approach can be useful for static website deployments, where JavaScript code should be placed into a subdirectory. \
+*Cannot be used together with `outfile`*.
+- `buildOptions.outfile: string` \
+Relative path to a file inside the CDK asset output directory. \
+For example `{ outfile: 'js/index.js' }` will create an asset with a single directory called `js`, which contains a single file `index.js`. This can be useful to rename the entry point. \
+*Cannot be used with multiple entryPoints or together with `outdir`.*
+- `buildOptions.absWorkingDir: string` \
+Absolute path to the [esbuild working directory](https://esbuild.github.io/api/#working-directory) and defaults to the [current working directory](https://en.wikipedia.org/wiki/Working_directory). \
+If paths cannot be found, a good starting point is to look at the concatenation of `absWorkingDir + entryPoint`. It must always be a valid absolute path pointing to the entry point. When needed, the probably easiest way to set absWorkingDir is to use a combination of `resolve` and `__dirname` (see "Library authors" section in the documentation).
+
+> https://esbuild.github.io/api/#build-api
+
+---
+
+##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.AssetProps.property.copyDir"></a>
+
+```typescript
+public readonly copyDir: string;
+```
+
+- *Type:* `string`
+
+Copy additional files to the output directory, before the build runs.
+
+Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
+
+---
+
+##### `entryPoints`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.AssetProps.property.entryPoints"></a>
+
+```typescript
+public readonly entryPoints: string | string[] | {[ key: string ]: string};
+```
+
+- *Type:* `string` | `string`[] | {[ key: string ]: `string`}
+
+A relative path or list or map of relative paths to the entry points of your code from the root of the project.
+
+E.g. `src/index.ts`.
+
+---
+
+##### `assetHash`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.AssetProps.property.assetHash"></a>
+
+```typescript
+public readonly assetHash: string;
+```
+
+- *Type:* `string`
+
+A hash of this asset, which is available at construction time.
+
+As this is a plain string, it can be used in construct IDs in order to enforce creation of a new resource when the content hash has changed.
+
+Defaults to a hash of all files in the resulting bundle.
+
+---
+
 ### BuildOptions <a name="@mrgrain/cdk-esbuild.BuildOptions"></a>
 
 #### Initializer <a name="[object Object].Initializer"></a>
@@ -513,63 +593,89 @@ public readonly write: boolean;
 
 ---
 
-### CodeConfig <a name="@mrgrain/cdk-esbuild.CodeConfig"></a>
+### BundlerProps <a name="@mrgrain/cdk-esbuild.BundlerProps"></a>
 
 #### Initializer <a name="[object Object].Initializer"></a>
 
 ```typescript
-import { CodeConfig } from '@mrgrain/cdk-esbuild'
+import { BundlerProps } from '@mrgrain/cdk-esbuild'
 
-const codeConfig: CodeConfig = { ... }
+const bundlerProps: BundlerProps = { ... }
 ```
 
-##### `inlineCode`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.CodeConfig.property.inlineCode"></a>
+##### `buildOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BundlerProps.property.buildOptions"></a>
 
 ```typescript
-public readonly inlineCode: string;
+public readonly buildOptions: BuildOptions;
 ```
 
-- *Type:* `string`
+- *Type:* [`@mrgrain/cdk-esbuild.BuildOptions`](#@mrgrain/cdk-esbuild.BuildOptions)
+
+Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.
+
+`buildOptions.outdir: string` \
+The actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \
+For example `{ outdir: 'js' }` will create an asset with a single directory called `js`, which contains all built files. This approach can be useful for static website deployments, where JavaScript code should be placed into a subdirectory. \
+*Cannot be used together with `outfile`*.
+- `buildOptions.outfile: string` \
+Relative path to a file inside the CDK asset output directory. \
+For example `{ outfile: 'js/index.js' }` will create an asset with a single directory called `js`, which contains a single file `index.js`. This can be useful to rename the entry point. \
+*Cannot be used with multiple entryPoints or together with `outdir`.*
+- `buildOptions.absWorkingDir: string` \
+Absolute path to the [esbuild working directory](https://esbuild.github.io/api/#working-directory) and defaults to the [current working directory](https://en.wikipedia.org/wiki/Working_directory). \
+If paths cannot be found, a good starting point is to look at the concatenation of `absWorkingDir + entryPoint`. It must always be a valid absolute path pointing to the entry point. When needed, the probably easiest way to set absWorkingDir is to use a combination of `resolve` and `__dirname` (see "Library authors" section in the documentation).
+
+> https://esbuild.github.io/api/#build-api
 
 ---
 
-##### `s3Location`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.CodeConfig.property.s3Location"></a>
+##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BundlerProps.property.copyDir"></a>
 
 ```typescript
-public readonly s3Location: Location;
+public readonly copyDir: string;
 ```
 
-- *Type:* [`@mrgrain/cdk-esbuild.Location`](#@mrgrain/cdk-esbuild.Location)
+- *Type:* `string`
+
+Copy additional files to the output directory, before the build runs.
+
+Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
 
 ---
 
-### EsbuildAssetProps <a name="@mrgrain/cdk-esbuild.EsbuildAssetProps"></a>
+### CodeConfig <a name="@mrgrain/cdk-esbuild.CodeConfig"></a>
 
 #### Initializer <a name="[object Object].Initializer"></a>
 
 ```typescript
-import { EsbuildAssetProps } from '@mrgrain/cdk-esbuild'
+import { CodeConfig } from '@mrgrain/cdk-esbuild'
 
-const esbuildAssetProps: EsbuildAssetProps = { ... }
+const codeConfig: CodeConfig = { ... }
 ```
 
-##### `assetHash`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildAssetProps.property.assetHash"></a>
+##### `s3Location`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.CodeConfig.property.s3Location"></a>
 
 ```typescript
-public readonly assetHash: string;
+public readonly s3Location: Location;
 ```
 
-- *Type:* `string`
-
-A hash of this asset, which is available at construction time.
+- *Type:* [`@aws-cdk/aws-s3.Location`](#@aws-cdk/aws-s3.Location)
 
-As this is a plain string, it
-can be used in construct IDs in order to enforce creation of a new resource when the content
-hash has changed.
+The location of the code in S3.
 
 ---
 
-##### `buildOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildAssetProps.property.buildOptions"></a>
+### JavaScriptCodeProps <a name="@mrgrain/cdk-esbuild.JavaScriptCodeProps"></a>
+
+#### Initializer <a name="[object Object].Initializer"></a>
+
+```typescript
+import { JavaScriptCodeProps } from '@mrgrain/cdk-esbuild'
+
+const javaScriptCodeProps: JavaScriptCodeProps = { ... }
+```
+
+##### `buildOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptCodeProps.property.buildOptions"></a>
 
 ```typescript
 public readonly buildOptions: BuildOptions;
@@ -577,11 +683,25 @@ public readonly buildOptions: BuildOptions;
 
 - *Type:* [`@mrgrain/cdk-esbuild.BuildOptions`](#@mrgrain/cdk-esbuild.BuildOptions)
 
-Options passed on to esbuild.
+Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.
+
+`buildOptions.outdir: string` \
+The actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \
+For example `{ outdir: 'js' }` will create an asset with a single directory called `js`, which contains all built files. This approach can be useful for static website deployments, where JavaScript code should be placed into a subdirectory. \
+*Cannot be used together with `outfile`*.
+- `buildOptions.outfile: string` \
+Relative path to a file inside the CDK asset output directory. \
+For example `{ outfile: 'js/index.js' }` will create an asset with a single directory called `js`, which contains a single file `index.js`. This can be useful to rename the entry point. \
+*Cannot be used with multiple entryPoints or together with `outdir`.*
+- `buildOptions.absWorkingDir: string` \
+Absolute path to the [esbuild working directory](https://esbuild.github.io/api/#working-directory) and defaults to the [current working directory](https://en.wikipedia.org/wiki/Working_directory). \
+If paths cannot be found, a good starting point is to look at the concatenation of `absWorkingDir + entryPoint`. It must always be a valid absolute path pointing to the entry point. When needed, the probably easiest way to set absWorkingDir is to use a combination of `resolve` and `__dirname` (see "Library authors" section in the documentation).
+
+> https://esbuild.github.io/api/#build-api
 
 ---
 
-##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildAssetProps.property.copyDir"></a>
+##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptCodeProps.property.copyDir"></a>
 
 ```typescript
 public readonly copyDir: string;
@@ -589,125 +709,125 @@ public readonly copyDir: string;
 
 - *Type:* `string`
 
-Relative path to a directory copied to the output BEFORE esbuild is run (i.e esbuild will overwrite existing files).
+Copy additional files to the output directory, before the build runs.
+
+Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
 
 ---
 
-##### `entryPoints`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.EsbuildAssetProps.property.entryPoints"></a>
+##### `assetHash`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptCodeProps.property.assetHash"></a>
 
 ```typescript
-public readonly entryPoints: string | string[] | {[ key: string ]: string};
+public readonly assetHash: string;
 ```
 
-- *Type:* `string` | `string`[] | {[ key: string ]: `string`}
+- *Type:* `string`
+
+A hash of this asset, which is available at construction time.
 
-Relative paths to the entrypoints of your code, e.g. `src/index.ts`.
+As this is a plain string, it can be used in construct IDs in order to enforce creation of a new resource when the content hash has changed.
+
+Defaults to a hash of all files in the resulting bundle.
 
 ---
 
-### EsbuildBundlingProps <a name="@mrgrain/cdk-esbuild.EsbuildBundlingProps"></a>
+### JavaScriptSourceProps <a name="@mrgrain/cdk-esbuild.JavaScriptSourceProps"></a>
 
 #### Initializer <a name="[object Object].Initializer"></a>
 
 ```typescript
-import { EsbuildBundlingProps } from '@mrgrain/cdk-esbuild'
+import { JavaScriptSourceProps } from '@mrgrain/cdk-esbuild'
 
-const esbuildBundlingProps: EsbuildBundlingProps = { ... }
+const javaScriptSourceProps: JavaScriptSourceProps = { ... }
 ```
 
-##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildBundlingProps.property.copyDir"></a>
+##### `buildOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptSourceProps.property.buildOptions"></a>
 
 ```typescript
-public readonly copyDir: string;
+public readonly buildOptions: BuildOptions;
 ```
 
-- *Type:* `string`
-
-Relative path to a directory copied to the output before esbuild is run (i.e esbuild will overwrite existing files).
-
----
+- *Type:* [`@mrgrain/cdk-esbuild.BuildOptions`](#@mrgrain/cdk-esbuild.BuildOptions)
 
-### EsbuildOptions <a name="@mrgrain/cdk-esbuild.EsbuildOptions"></a>
+Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.
 
-#### Initializer <a name="[object Object].Initializer"></a>
+`buildOptions.outdir: string` \
+The actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \
+For example `{ outdir: 'js' }` will create an asset with a single directory called `js`, which contains all built files. This approach can be useful for static website deployments, where JavaScript code should be placed into a subdirectory. \
+*Cannot be used together with `outfile`*.
+- `buildOptions.outfile: string` \
+Relative path to a file inside the CDK asset output directory. \
+For example `{ outfile: 'js/index.js' }` will create an asset with a single directory called `js`, which contains a single file `index.js`. This can be useful to rename the entry point. \
+*Cannot be used with multiple entryPoints or together with `outdir`.*
+- `buildOptions.absWorkingDir: string` \
+Absolute path to the [esbuild working directory](https://esbuild.github.io/api/#working-directory) and defaults to the [current working directory](https://en.wikipedia.org/wiki/Working_directory). \
+If paths cannot be found, a good starting point is to look at the concatenation of `absWorkingDir + entryPoint`. It must always be a valid absolute path pointing to the entry point. When needed, the probably easiest way to set absWorkingDir is to use a combination of `resolve` and `__dirname` (see "Library authors" section in the documentation).
 
-```typescript
-import { EsbuildOptions } from '@mrgrain/cdk-esbuild'
+> https://esbuild.github.io/api/#build-api
 
-const esbuildOptions: EsbuildOptions = { ... }
-```
+---
 
-##### `absWorkingDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.absWorkingDir"></a>
+##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptSourceProps.property.copyDir"></a>
 
 ```typescript
-public readonly absWorkingDir: string;
+public readonly copyDir: string;
 ```
 
 - *Type:* `string`
 
----
-
-##### `allowOverwrite`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.allowOverwrite"></a>
-
-```typescript
-public readonly allowOverwrite: boolean;
-```
+Copy additional files to the output directory, before the build runs.
 
-- *Type:* `boolean`
+Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
 
 ---
 
-##### `assetNames`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.assetNames"></a>
+##### `assetHash`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptSourceProps.property.assetHash"></a>
 
 ```typescript
-public readonly assetNames: string;
+public readonly assetHash: string;
 ```
 
 - *Type:* `string`
 
----
-
-##### `banner`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.banner"></a>
+A hash of this asset, which is available at construction time.
 
-```typescript
-public readonly banner: {[ key: string ]: string};
-```
+As this is a plain string, it can be used in construct IDs in order to enforce creation of a new resource when the content hash has changed.
 
-- *Type:* {[ key: string ]: `string`}
+Defaults to a hash of all files in the resulting bundle.
 
 ---
 
-##### `bundle`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.bundle"></a>
+### TransformOptions <a name="@mrgrain/cdk-esbuild.TransformOptions"></a>
 
-```typescript
-public readonly bundle: boolean;
-```
+#### Initializer <a name="[object Object].Initializer"></a>
 
-- *Type:* `boolean`
+```typescript
+import { TransformOptions } from '@mrgrain/cdk-esbuild'
 
----
+const transformOptions: TransformOptions = { ... }
+```
 
-##### `charset`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.charset"></a>
+##### `banner`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.banner"></a>
 
 ```typescript
-public readonly charset: string;
+public readonly banner: string;
 ```
 
 - *Type:* `string`
 
 ---
 
-##### `chunkNames`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.chunkNames"></a>
+##### `charset`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.charset"></a>
 
 ```typescript
-public readonly chunkNames: string;
+public readonly charset: string;
 ```
 
 - *Type:* `string`
 
 ---
 
-##### `color`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.color"></a>
+##### `color`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.color"></a>
 
 ```typescript
 public readonly color: boolean;
@@ -717,17 +837,7 @@ public readonly color: boolean;
 
 ---
 
-##### `conditions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.conditions"></a>
-
-```typescript
-public readonly conditions: string[];
-```
-
-- *Type:* `string`[]
-
----
-
-##### `define`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.define"></a>
+##### `define`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.define"></a>
 
 ```typescript
 public readonly define: {[ key: string ]: string};
@@ -737,37 +847,17 @@ public readonly define: {[ key: string ]: string};
 
 ---
 
-##### `entryNames`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.entryNames"></a>
+##### `footer`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.footer"></a>
 
 ```typescript
-public readonly entryNames: string;
+public readonly footer: string;
 ```
 
 - *Type:* `string`
 
 ---
 
-##### `external`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.external"></a>
-
-```typescript
-public readonly external: string[];
-```
-
-- *Type:* `string`[]
-
----
-
-##### `footer`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.footer"></a>
-
-```typescript
-public readonly footer: {[ key: string ]: string};
-```
-
-- *Type:* {[ key: string ]: `string`}
-
----
-
-##### `format`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.format"></a>
+##### `format`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.format"></a>
 
 ```typescript
 public readonly format: string;
@@ -777,7 +867,7 @@ public readonly format: string;
 
 ---
 
-##### `globalName`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.globalName"></a>
+##### `globalName`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.globalName"></a>
 
 ```typescript
 public readonly globalName: string;
@@ -787,7 +877,7 @@ public readonly globalName: string;
 
 ---
 
-##### `ignoreAnnotations`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.ignoreAnnotations"></a>
+##### `ignoreAnnotations`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.ignoreAnnotations"></a>
 
 ```typescript
 public readonly ignoreAnnotations: boolean;
@@ -797,27 +887,7 @@ public readonly ignoreAnnotations: boolean;
 
 ---
 
-##### `incremental`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.incremental"></a>
-
-```typescript
-public readonly incremental: boolean;
-```
-
-- *Type:* `boolean`
-
----
-
-##### `inject`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.inject"></a>
-
-```typescript
-public readonly inject: string[];
-```
-
-- *Type:* `string`[]
-
----
-
-##### `jsx`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.jsx"></a>
+##### `jsx`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.jsx"></a>
 
 ```typescript
 public readonly jsx: string;
@@ -827,7 +897,7 @@ public readonly jsx: string;
 
 ---
 
-##### `jsxFactory`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.jsxFactory"></a>
+##### `jsxFactory`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.jsxFactory"></a>
 
 ```typescript
 public readonly jsxFactory: string;
@@ -837,7 +907,7 @@ public readonly jsxFactory: string;
 
 ---
 
-##### `jsxFragment`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.jsxFragment"></a>
+##### `jsxFragment`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.jsxFragment"></a>
 
 ```typescript
 public readonly jsxFragment: string;
@@ -847,7 +917,7 @@ public readonly jsxFragment: string;
 
 ---
 
-##### `keepNames`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.keepNames"></a>
+##### `keepNames`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.keepNames"></a>
 
 ```typescript
 public readonly keepNames: boolean;
@@ -857,7 +927,7 @@ public readonly keepNames: boolean;
 
 ---
 
-##### `legalComments`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.legalComments"></a>
+##### `legalComments`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.legalComments"></a>
 
 ```typescript
 public readonly legalComments: string;
@@ -867,17 +937,17 @@ public readonly legalComments: string;
 
 ---
 
-##### `loader`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.loader"></a>
+##### `loader`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.loader"></a>
 
 ```typescript
-public readonly loader: {[ key: string ]: string};
+public readonly loader: string;
 ```
 
-- *Type:* {[ key: string ]: `string`}
+- *Type:* `string`
 
 ---
 
-##### `logLevel`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.logLevel"></a>
+##### `logLevel`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.logLevel"></a>
 
 ```typescript
 public readonly logLevel: string;
@@ -887,7 +957,7 @@ public readonly logLevel: string;
 
 ---
 
-##### `logLimit`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.logLimit"></a>
+##### `logLimit`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.logLimit"></a>
 
 ```typescript
 public readonly logLimit: number;
@@ -897,267 +967,177 @@ public readonly logLimit: number;
 
 ---
 
-##### `mainFields`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.mainFields"></a>
+##### `minify`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.minify"></a>
 
 ```typescript
-public readonly mainFields: string[];
+public readonly minify: boolean;
 ```
 
-- *Type:* `string`[]
+- *Type:* `boolean`
 
 ---
 
-##### `metafile`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.metafile"></a>
+##### `minifyIdentifiers`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.minifyIdentifiers"></a>
 
 ```typescript
-public readonly metafile: boolean;
+public readonly minifyIdentifiers: boolean;
 ```
 
 - *Type:* `boolean`
 
 ---
 
-##### `minify`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.minify"></a>
+##### `minifySyntax`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.minifySyntax"></a>
 
 ```typescript
-public readonly minify: boolean;
+public readonly minifySyntax: boolean;
 ```
 
 - *Type:* `boolean`
 
 ---
 
-##### `minifyIdentifiers`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.minifyIdentifiers"></a>
+##### `minifyWhitespace`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.minifyWhitespace"></a>
 
 ```typescript
-public readonly minifyIdentifiers: boolean;
+public readonly minifyWhitespace: boolean;
 ```
 
 - *Type:* `boolean`
 
 ---
 
-##### `minifySyntax`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.minifySyntax"></a>
+##### `pure`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.pure"></a>
 
 ```typescript
-public readonly minifySyntax: boolean;
+public readonly pure: string[];
 ```
 
-- *Type:* `boolean`
+- *Type:* `string`[]
 
 ---
 
-##### `minifyWhitespace`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.minifyWhitespace"></a>
+##### `sourcefile`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.sourcefile"></a>
 
 ```typescript
-public readonly minifyWhitespace: boolean;
+public readonly sourcefile: string;
 ```
 
-- *Type:* `boolean`
+- *Type:* `string`
 
 ---
 
-##### `nodePaths`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.nodePaths"></a>
+##### `sourcemap`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.sourcemap"></a>
 
 ```typescript
-public readonly nodePaths: string[];
+public readonly sourcemap: boolean | string;
 ```
 
-- *Type:* `string`[]
+- *Type:* `boolean` | `string`
 
 ---
 
-##### `outbase`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.outbase"></a>
+##### `sourceRoot`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.sourceRoot"></a>
 
 ```typescript
-public readonly outbase: string;
+public readonly sourceRoot: string;
 ```
 
 - *Type:* `string`
 
 ---
 
-##### `outdir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.outdir"></a>
+##### `sourcesContent`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.sourcesContent"></a>
 
 ```typescript
-public readonly outdir: string;
+public readonly sourcesContent: boolean;
 ```
 
-- *Type:* `string`
+- *Type:* `boolean`
 
 ---
 
-##### `outExtension`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.outExtension"></a>
+##### `target`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.target"></a>
 
 ```typescript
-public readonly outExtension: {[ key: string ]: string};
+public readonly target: string | string[];
 ```
 
-- *Type:* {[ key: string ]: `string`}
+- *Type:* `string` | `string`[]
 
 ---
 
-##### `outfile`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.outfile"></a>
+##### `treeShaking`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.treeShaking"></a>
 
 ```typescript
-public readonly outfile: string;
+public readonly treeShaking: boolean;
 ```
 
-- *Type:* `string`
+- *Type:* `boolean`
 
 ---
 
-##### `platform`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.platform"></a>
+##### `tsconfigRaw`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.tsconfigRaw"></a>
 
 ```typescript
-public readonly platform: string;
+public readonly tsconfigRaw: string;
 ```
 
 - *Type:* `string`
 
 ---
 
-##### `preserveSymlinks`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.preserveSymlinks"></a>
+### TypeScriptCodeProps <a name="@mrgrain/cdk-esbuild.TypeScriptCodeProps"></a>
+
+#### Initializer <a name="[object Object].Initializer"></a>
 
 ```typescript
-public readonly preserveSymlinks: boolean;
-```
-
-- *Type:* `boolean`
-
----
-
-##### `publicPath`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.publicPath"></a>
-
-```typescript
-public readonly publicPath: string;
-```
-
-- *Type:* `string`
-
----
-
-##### `pure`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.pure"></a>
-
-```typescript
-public readonly pure: string[];
-```
-
-- *Type:* `string`[]
-
----
-
-##### `resolveExtensions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.resolveExtensions"></a>
-
-```typescript
-public readonly resolveExtensions: string[];
-```
-
-- *Type:* `string`[]
+import { TypeScriptCodeProps } from '@mrgrain/cdk-esbuild'
 
----
-
-##### `sourcemap`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.sourcemap"></a>
-
-```typescript
-public readonly sourcemap: boolean | string;
+const typeScriptCodeProps: TypeScriptCodeProps = { ... }
 ```
 
-- *Type:* `boolean` | `string`
-
----
-
-##### `sourceRoot`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.sourceRoot"></a>
+##### `buildOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptCodeProps.property.buildOptions"></a>
 
 ```typescript
-public readonly sourceRoot: string;
-```
-
-- *Type:* `string`
-
----
-
-##### `sourcesContent`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.sourcesContent"></a>
-
-```typescript
-public readonly sourcesContent: boolean;
-```
-
-- *Type:* `boolean`
-
----
-
-##### `splitting`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.splitting"></a>
-
-```typescript
-public readonly splitting: boolean;
-```
-
-- *Type:* `boolean`
-
----
-
-##### `target`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.target"></a>
-
-```typescript
-public readonly target: string | string[];
+public readonly buildOptions: BuildOptions;
 ```
 
-- *Type:* `string` | `string`[]
-
----
+- *Type:* [`@mrgrain/cdk-esbuild.BuildOptions`](#@mrgrain/cdk-esbuild.BuildOptions)
 
-##### `treeShaking`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.treeShaking"></a>
+Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.
 
-```typescript
-public readonly treeShaking: boolean;
-```
+`buildOptions.outdir: string` \
+The actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \
+For example `{ outdir: 'js' }` will create an asset with a single directory called `js`, which contains all built files. This approach can be useful for static website deployments, where JavaScript code should be placed into a subdirectory. \
+*Cannot be used together with `outfile`*.
+- `buildOptions.outfile: string` \
+Relative path to a file inside the CDK asset output directory. \
+For example `{ outfile: 'js/index.js' }` will create an asset with a single directory called `js`, which contains a single file `index.js`. This can be useful to rename the entry point. \
+*Cannot be used with multiple entryPoints or together with `outdir`.*
+- `buildOptions.absWorkingDir: string` \
+Absolute path to the [esbuild working directory](https://esbuild.github.io/api/#working-directory) and defaults to the [current working directory](https://en.wikipedia.org/wiki/Working_directory). \
+If paths cannot be found, a good starting point is to look at the concatenation of `absWorkingDir + entryPoint`. It must always be a valid absolute path pointing to the entry point. When needed, the probably easiest way to set absWorkingDir is to use a combination of `resolve` and `__dirname` (see "Library authors" section in the documentation).
 
-- *Type:* `boolean`
+> https://esbuild.github.io/api/#build-api
 
 ---
 
-##### `tsconfig`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.tsconfig"></a>
+##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptCodeProps.property.copyDir"></a>
 
 ```typescript
-public readonly tsconfig: string;
+public readonly copyDir: string;
 ```
 
 - *Type:* `string`
 
----
-
-##### `write`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.write"></a>
-
-```typescript
-public readonly write: boolean;
-```
+Copy additional files to the output directory, before the build runs.
 
-- *Type:* `boolean`
+Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
 
 ---
 
-##### `entryPoints`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.EsbuildOptions.property.entryPoints"></a>
-
-```typescript
-public readonly entryPoints: string[] | {[ key: string ]: string};
-```
-
-- *Type:* `string`[] | {[ key: string ]: `string`}
-
----
-
-### EsbuildProps <a name="@mrgrain/cdk-esbuild.EsbuildProps"></a>
-
-#### Initializer <a name="[object Object].Initializer"></a>
-
-```typescript
-import { EsbuildProps } from '@mrgrain/cdk-esbuild'
-
-const esbuildProps: EsbuildProps = { ... }
-```
-
-##### `assetHash`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildProps.property.assetHash"></a>
+##### `assetHash`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptCodeProps.property.assetHash"></a>
 
 ```typescript
 public readonly assetHash: string;
@@ -1167,417 +1147,171 @@ public readonly assetHash: string;
 
 A hash of this asset, which is available at construction time.
 
-As this is a plain string, it
-can be used in construct IDs in order to enforce creation of a new resource when the content
-hash has changed.
-
----
-
-##### `buildOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildProps.property.buildOptions"></a>
-
-```typescript
-public readonly buildOptions: BuildOptions;
-```
-
-- *Type:* [`@mrgrain/cdk-esbuild.BuildOptions`](#@mrgrain/cdk-esbuild.BuildOptions)
-
-Options passed on to esbuild.
-
----
-
-##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildProps.property.copyDir"></a>
-
-```typescript
-public readonly copyDir: string;
-```
-
-- *Type:* `string`
-
-Relative path to a directory copied to the output BEFORE esbuild is run (i.e esbuild will overwrite existing files).
-
----
-
-### Location <a name="@mrgrain/cdk-esbuild.Location"></a>
+As this is a plain string, it can be used in construct IDs in order to enforce creation of a new resource when the content hash has changed.
 
-#### Initializer <a name="[object Object].Initializer"></a>
-
-```typescript
-import { Location } from '@mrgrain/cdk-esbuild'
-
-const location: Location = { ... }
-```
-
-##### `bucketName`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.Location.property.bucketName"></a>
-
-```typescript
-public readonly bucketName: string;
-```
-
-- *Type:* `string`
+Defaults to a hash of all files in the resulting bundle.
 
 ---
 
-##### `objectKey`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.Location.property.objectKey"></a>
-
-```typescript
-public readonly objectKey: string;
-```
-
-- *Type:* `string`
-
----
-
-### TransformOptions <a name="@mrgrain/cdk-esbuild.TransformOptions"></a>
+### TypeScriptSourceProps <a name="@mrgrain/cdk-esbuild.TypeScriptSourceProps"></a>
 
 #### Initializer <a name="[object Object].Initializer"></a>
 
 ```typescript
-import { TransformOptions } from '@mrgrain/cdk-esbuild'
-
-const transformOptions: TransformOptions = { ... }
-```
-
-##### `banner`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.banner"></a>
-
-```typescript
-public readonly banner: string;
-```
-
-- *Type:* `string`
-
----
-
-##### `charset`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.charset"></a>
-
-```typescript
-public readonly charset: string;
-```
-
-- *Type:* `string`
-
----
-
-##### `color`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.color"></a>
+import { TypeScriptSourceProps } from '@mrgrain/cdk-esbuild'
 
-```typescript
-public readonly color: boolean;
+const typeScriptSourceProps: TypeScriptSourceProps = { ... }
 ```
 
-- *Type:* `boolean`
-
----
-
-##### `define`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.define"></a>
-
-```typescript
-public readonly define: {[ key: string ]: string};
-```
-
-- *Type:* {[ key: string ]: `string`}
-
----
-
-##### `footer`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.footer"></a>
-
-```typescript
-public readonly footer: string;
-```
-
-- *Type:* `string`
-
----
-
-##### `format`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.format"></a>
-
-```typescript
-public readonly format: string;
-```
-
-- *Type:* `string`
-
----
-
-##### `globalName`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.globalName"></a>
-
-```typescript
-public readonly globalName: string;
-```
-
-- *Type:* `string`
-
----
-
-##### `ignoreAnnotations`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.ignoreAnnotations"></a>
-
-```typescript
-public readonly ignoreAnnotations: boolean;
-```
-
-- *Type:* `boolean`
-
----
-
-##### `jsx`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.jsx"></a>
-
-```typescript
-public readonly jsx: string;
-```
-
-- *Type:* `string`
-
----
-
-##### `jsxFactory`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.jsxFactory"></a>
-
-```typescript
-public readonly jsxFactory: string;
-```
-
-- *Type:* `string`
-
----
-
-##### `jsxFragment`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.jsxFragment"></a>
+##### `buildOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptSourceProps.property.buildOptions"></a>
 
 ```typescript
-public readonly jsxFragment: string;
+public readonly buildOptions: BuildOptions;
 ```
 
-- *Type:* `string`
-
----
+- *Type:* [`@mrgrain/cdk-esbuild.BuildOptions`](#@mrgrain/cdk-esbuild.BuildOptions)
 
-##### `keepNames`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.keepNames"></a>
+Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.
 
-```typescript
-public readonly keepNames: boolean;
-```
+`buildOptions.outdir: string` \
+The actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \
+For example `{ outdir: 'js' }` will create an asset with a single directory called `js`, which contains all built files. This approach can be useful for static website deployments, where JavaScript code should be placed into a subdirectory. \
+*Cannot be used together with `outfile`*.
+- `buildOptions.outfile: string` \
+Relative path to a file inside the CDK asset output directory. \
+For example `{ outfile: 'js/index.js' }` will create an asset with a single directory called `js`, which contains a single file `index.js`. This can be useful to rename the entry point. \
+*Cannot be used with multiple entryPoints or together with `outdir`.*
+- `buildOptions.absWorkingDir: string` \
+Absolute path to the [esbuild working directory](https://esbuild.github.io/api/#working-directory) and defaults to the [current working directory](https://en.wikipedia.org/wiki/Working_directory). \
+If paths cannot be found, a good starting point is to look at the concatenation of `absWorkingDir + entryPoint`. It must always be a valid absolute path pointing to the entry point. When needed, the probably easiest way to set absWorkingDir is to use a combination of `resolve` and `__dirname` (see "Library authors" section in the documentation).
 
-- *Type:* `boolean`
+> https://esbuild.github.io/api/#build-api
 
 ---
 
-##### `legalComments`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.legalComments"></a>
+##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptSourceProps.property.copyDir"></a>
 
 ```typescript
-public readonly legalComments: string;
+public readonly copyDir: string;
 ```
 
 - *Type:* `string`
 
----
+Copy additional files to the output directory, before the build runs.
 
-##### `loader`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.loader"></a>
-
-```typescript
-public readonly loader: string;
-```
-
-- *Type:* `string`
+Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
 
 ---
 
-##### `logLevel`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.logLevel"></a>
+##### `assetHash`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptSourceProps.property.assetHash"></a>
 
 ```typescript
-public readonly logLevel: string;
+public readonly assetHash: string;
 ```
 
 - *Type:* `string`
 
----
-
-##### `logLimit`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.logLimit"></a>
+A hash of this asset, which is available at construction time.
 
-```typescript
-public readonly logLimit: number;
-```
+As this is a plain string, it can be used in construct IDs in order to enforce creation of a new resource when the content hash has changed.
 
-- *Type:* `number`
+Defaults to a hash of all files in the resulting bundle.
 
 ---
 
-##### `minify`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.minify"></a>
+## Classes <a name="Classes"></a>
 
-```typescript
-public readonly minify: boolean;
-```
+### EsbuildBundler <a name="@mrgrain/cdk-esbuild.EsbuildBundler"></a>
 
-- *Type:* `boolean`
+Low-level construct that can be used where `BundlingOptions` are required.
 
----
+This class directly interfaces with esbuild and provides almost no configuration safeguards.
 
-##### `minifyIdentifiers`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.minifyIdentifiers"></a>
+#### Initializers <a name="@mrgrain/cdk-esbuild.EsbuildBundler.Initializer"></a>
 
 ```typescript
-public readonly minifyIdentifiers: boolean;
-```
-
-- *Type:* `boolean`
-
----
+import { EsbuildBundler } from '@mrgrain/cdk-esbuild'
 
-##### `minifySyntax`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.minifySyntax"></a>
-
-```typescript
-public readonly minifySyntax: boolean;
+new EsbuildBundler(entryPoints: string | string[] | {[ key: string ]: string}, props: BundlerProps)
 ```
 
-- *Type:* `boolean`
-
----
+##### `entryPoints`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.EsbuildBundler.parameter.entryPoints"></a>
 
-##### `minifyWhitespace`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.minifyWhitespace"></a>
+- *Type:* `string` | `string`[] | {[ key: string ]: `string`}
 
-```typescript
-public readonly minifyWhitespace: boolean;
-```
+A relative path or list or map of relative paths to the entry points of your code from the root of the project.
 
-- *Type:* `boolean`
+E.g. `src/index.ts`.
 
 ---
 
-##### `pure`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.pure"></a>
+##### `props`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.EsbuildBundler.parameter.props"></a>
 
-```typescript
-public readonly pure: string[];
-```
+- *Type:* [`@mrgrain/cdk-esbuild.BundlerProps`](#@mrgrain/cdk-esbuild.BundlerProps)
 
-- *Type:* `string`[]
+Props to change the behaviour of the bundler.
 
 ---
 
-##### `sourcefile`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.sourcefile"></a>
-
-```typescript
-public readonly sourcefile: string;
-```
 
-- *Type:* `string`
 
----
+#### Properties <a name="Properties"></a>
 
-##### `sourcemap`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.sourcemap"></a>
+##### `entryPoints`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.EsbuildBundler.property.entryPoints"></a>
 
 ```typescript
-public readonly sourcemap: boolean | string;
+public readonly entryPoints: string | string[] | {[ key: string ]: string};
 ```
 
-- *Type:* `boolean` | `string`
-
----
-
-##### `sourceRoot`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.sourceRoot"></a>
+- *Type:* `string` | `string`[] | {[ key: string ]: `string`}
 
-```typescript
-public readonly sourceRoot: string;
-```
+A relative path or list or map of relative paths to the entry points of your code from the root of the project.
 
-- *Type:* `string`
+E.g. `src/index.ts`.
 
 ---
 
-##### `sourcesContent`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.sourcesContent"></a>
+##### ~~`image`~~<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.EsbuildBundler.property.image"></a>
 
-```typescript
-public readonly sourcesContent: boolean;
-```
-
-- *Type:* `boolean`
-
----
-
-##### `target`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.target"></a>
+- *Deprecated:* This value is ignored since the bundler is always using a locally installed version of esbuild. However the property is required to comply with the `BundlingOptions` interface.
 
 ```typescript
-public readonly target: string | string[];
+public readonly image: DockerImage;
 ```
 
-- *Type:* `string` | `string`[]
+- *Type:* [`@aws-cdk/core.DockerImage`](#@aws-cdk/core.DockerImage)
 
 ---
 
-##### `treeShaking`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.treeShaking"></a>
+##### `local`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.EsbuildBundler.property.local"></a>
 
 ```typescript
-public readonly treeShaking: boolean;
+public readonly local: ILocalBundling;
 ```
 
-- *Type:* `boolean`
-
----
-
-##### `tsconfigRaw`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.tsconfigRaw"></a>
-
-```typescript
-public readonly tsconfigRaw: string;
-```
+- *Type:* [`@aws-cdk/core.ILocalBundling`](#@aws-cdk/core.ILocalBundling)
 
-- *Type:* `string`
+Implementation of `ILocalBundling` interface, responsible for calling esbuild functions.
 
 ---
 
-## Classes <a name="Classes"></a>
-
-### EsbuildBundling <a name="@mrgrain/cdk-esbuild.EsbuildBundling"></a>
-
-#### Initializers <a name="@mrgrain/cdk-esbuild.EsbuildBundling.Initializer"></a>
+##### `props`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.EsbuildBundler.property.props"></a>
 
 ```typescript
-import { EsbuildBundling } from '@mrgrain/cdk-esbuild'
-
-new EsbuildBundling(buildOptions: EsbuildOptions, bundlerProps?: EsbuildBundlingProps)
+public readonly props: BundlerProps;
 ```
 
-##### `buildOptions`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.EsbuildBundling.parameter.buildOptions"></a>
+- *Type:* [`@mrgrain/cdk-esbuild.BundlerProps`](#@mrgrain/cdk-esbuild.BundlerProps)
 
-- *Type:* [`@mrgrain/cdk-esbuild.EsbuildOptions`](#@mrgrain/cdk-esbuild.EsbuildOptions)
-
----
-
-##### `bundlerProps`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.EsbuildBundling.parameter.bundlerProps"></a>
-
-- *Type:* [`@mrgrain/cdk-esbuild.EsbuildBundlingProps`](#@mrgrain/cdk-esbuild.EsbuildBundlingProps)
-
----
-
-
-
-#### Properties <a name="Properties"></a>
-
-##### `buildOptions`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.EsbuildBundling.property.buildOptions"></a>
-
-```typescript
-public readonly buildOptions: EsbuildOptions;
-```
-
-- *Type:* [`@mrgrain/cdk-esbuild.EsbuildOptions`](#@mrgrain/cdk-esbuild.EsbuildOptions)
-
----
-
-##### `image`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.EsbuildBundling.property.image"></a>
-
-```typescript
-public readonly image: DockerImage;
-```
-
-- *Type:* [`@aws-cdk/core.DockerImage`](#@aws-cdk/core.DockerImage)
-
----
-
-##### `local`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.EsbuildBundling.property.local"></a>
-
-```typescript
-public readonly local: LocalBundler;
-```
-
-- *Type:* [`@mrgrain/cdk-esbuild.LocalBundler`](#@mrgrain/cdk-esbuild.LocalBundler)
+Props to change the behaviour of the bundler.
 
 ---
 
 
 ### InlineJavaScriptCode <a name="@mrgrain/cdk-esbuild.InlineJavaScriptCode"></a>
 
+An implementation of `lambda.InlineCode` using the esbuild Transform API. Inline function code is limited to 4 KiB after transformation.
+
 #### Initializers <a name="@mrgrain/cdk-esbuild.InlineJavaScriptCode.Initializer"></a>
 
 ```typescript
@@ -1590,12 +1324,22 @@ new InlineJavaScriptCode(code: string, transformOptions?: TransformOptions)
 
 - *Type:* `string`
 
+The inline code to be transformed.
+
 ---
 
 ##### `transformOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.InlineJavaScriptCode.parameter.transformOptions"></a>
 
 - *Type:* [`@mrgrain/cdk-esbuild.TransformOptions`](#@mrgrain/cdk-esbuild.TransformOptions)
 
+Transform options passed on to esbuild.
+
+Please refer to the esbuild Transform API docs for details. \
+Default values for `transformOptions`:
+- `loader='js'`
+
+> https://esbuild.github.io/api/#transform-api
+
 ---
 
 
@@ -1604,6 +1348,8 @@ new InlineJavaScriptCode(code: string, transformOptions?: TransformOptions)
 
 ### InlineJsxCode <a name="@mrgrain/cdk-esbuild.InlineJsxCode"></a>
 
+An implementation of `lambda.InlineCode` using the esbuild Transform API. Inline function code is limited to 4 KiB after transformation.
+
 #### Initializers <a name="@mrgrain/cdk-esbuild.InlineJsxCode.Initializer"></a>
 
 ```typescript
@@ -1616,12 +1362,22 @@ new InlineJsxCode(code: string, transformOptions?: TransformOptions)
 
 - *Type:* `string`
 
+The inline code to be transformed.
+
 ---
 
 ##### `transformOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.InlineJsxCode.parameter.transformOptions"></a>
 
 - *Type:* [`@mrgrain/cdk-esbuild.TransformOptions`](#@mrgrain/cdk-esbuild.TransformOptions)
 
+Transform options passed on to esbuild.
+
+Please refer to the esbuild Transform API docs for details. \
+Default values for `transformOptions`:
+- `loader='jsx'`
+
+> https://esbuild.github.io/api/#transform-api
+
 ---
 
 
@@ -1630,6 +1386,8 @@ new InlineJsxCode(code: string, transformOptions?: TransformOptions)
 
 ### InlineTsxCode <a name="@mrgrain/cdk-esbuild.InlineTsxCode"></a>
 
+An implementation of `lambda.InlineCode` using the esbuild Transform API. Inline function code is limited to 4 KiB after transformation.
+
 #### Initializers <a name="@mrgrain/cdk-esbuild.InlineTsxCode.Initializer"></a>
 
 ```typescript
@@ -1642,12 +1400,22 @@ new InlineTsxCode(code: string, transformOptions?: TransformOptions)
 
 - *Type:* `string`
 
+The inline code to be transformed.
+
 ---
 
 ##### `transformOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.InlineTsxCode.parameter.transformOptions"></a>
 
 - *Type:* [`@mrgrain/cdk-esbuild.TransformOptions`](#@mrgrain/cdk-esbuild.TransformOptions)
 
+Transform options passed on to esbuild.
+
+Please refer to the esbuild Transform API docs for details. \
+Default values for `transformOptions`:
+- `loader='tsx'`
+
+> https://esbuild.github.io/api/#transform-api
+
 ---
 
 
@@ -1656,6 +1424,8 @@ new InlineTsxCode(code: string, transformOptions?: TransformOptions)
 
 ### InlineTypeScriptCode <a name="@mrgrain/cdk-esbuild.InlineTypeScriptCode"></a>
 
+An implementation of `lambda.InlineCode` using the esbuild Transform API. Inline function code is limited to 4 KiB after transformation.
+
 #### Initializers <a name="@mrgrain/cdk-esbuild.InlineTypeScriptCode.Initializer"></a>
 
 ```typescript
@@ -1668,12 +1438,22 @@ new InlineTypeScriptCode(code: string, transformOptions?: TransformOptions)
 
 - *Type:* `string`
 
+The inline code to be transformed.
+
 ---
 
 ##### `transformOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.InlineTypeScriptCode.parameter.transformOptions"></a>
 
 - *Type:* [`@mrgrain/cdk-esbuild.TransformOptions`](#@mrgrain/cdk-esbuild.TransformOptions)
 
+Transform options passed on to esbuild.
+
+Please refer to the esbuild Transform API docs for details. \
+Default values for `transformOptions`:
+- `loader='ts'`
+
+> https://esbuild.github.io/api/#transform-api
+
 ---
 
 
@@ -1682,12 +1462,16 @@ new InlineTypeScriptCode(code: string, transformOptions?: TransformOptions)
 
 ### JavaScriptAsset <a name="@mrgrain/cdk-esbuild.JavaScriptAsset"></a>
 
+Bundles the entry points and creates a CDK asset which is uploaded to the bootstrapped CDK S3 bucket during deployment.
+
+The asset can be used by other constructs.
+
 #### Initializers <a name="@mrgrain/cdk-esbuild.JavaScriptAsset.Initializer"></a>
 
 ```typescript
 import { JavaScriptAsset } from '@mrgrain/cdk-esbuild'
 
-new JavaScriptAsset(scope: Construct, id: string, __2: EsbuildAssetProps)
+new JavaScriptAsset(scope: Construct, id: string, props: AssetProps)
 ```
 
 ##### `scope`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptAsset.parameter.scope"></a>
@@ -1702,9 +1486,9 @@ new JavaScriptAsset(scope: Construct, id: string, __2: EsbuildAssetProps)
 
 ---
 
-##### `__2`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptAsset.parameter.__2"></a>
+##### `props`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptAsset.parameter.props"></a>
 
-- *Type:* [`@mrgrain/cdk-esbuild.EsbuildAssetProps`](#@mrgrain/cdk-esbuild.EsbuildAssetProps)
+- *Type:* [`@mrgrain/cdk-esbuild.AssetProps`](#@mrgrain/cdk-esbuild.AssetProps)
 
 ---
 
@@ -1714,23 +1498,36 @@ new JavaScriptAsset(scope: Construct, id: string, __2: EsbuildAssetProps)
 
 ### JavaScriptCode <a name="@mrgrain/cdk-esbuild.JavaScriptCode"></a>
 
+Represents the deployed JavaScript Code.
+
 #### Initializers <a name="@mrgrain/cdk-esbuild.JavaScriptCode.Initializer"></a>
 
 ```typescript
 import { JavaScriptCode } from '@mrgrain/cdk-esbuild'
 
-new JavaScriptCode(entryPoints: string | string[] | {[ key: string ]: string}, props?: EsbuildProps)
+new JavaScriptCode(entryPoints: string | string[] | {[ key: string ]: string}, props?: JavaScriptCodeProps)
 ```
 
 ##### `entryPoints`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptCode.parameter.entryPoints"></a>
 
 - *Type:* `string` | `string`[] | {[ key: string ]: `string`}
 
+A relative path or list or map of relative paths to the entry points of your code from the root of the project.
+
+E.g. `src/index.ts`.
+
 ---
 
 ##### `props`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptCode.parameter.props"></a>
 
-- *Type:* [`@mrgrain/cdk-esbuild.EsbuildProps`](#@mrgrain/cdk-esbuild.EsbuildProps)
+- *Type:* [`@mrgrain/cdk-esbuild.JavaScriptCodeProps`](#@mrgrain/cdk-esbuild.JavaScriptCodeProps)
+
+Props to change the behavior of the bundler.
+
+Default values for `props.buildOptions`:
+- `bundle=true`
+- `platform=node`
+- `target=nodeX` with X being the major node version running locally
 
 ---
 
@@ -1769,17 +1566,9 @@ public bindToResource(resource: CfnResource, options?: ResourceBindOptions)
 
 #### Properties <a name="Properties"></a>
 
-##### `assetClass`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptCode.property.assetClass"></a>
+##### ~~`isInline`~~<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptCode.property.isInline"></a>
 
-```typescript
-public readonly assetClass: JavaScriptAsset;
-```
-
-- *Type:* [`@mrgrain/cdk-esbuild.JavaScriptAsset`](#@mrgrain/cdk-esbuild.JavaScriptAsset)
-
----
-
-##### `isInline`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptCode.property.isInline"></a>
+- *Deprecated:* this value is ignored since inline is now determined based on the the inlineCode field of CodeConfig returned from bind().
 
 ```typescript
 public readonly isInline: boolean;
@@ -1787,6 +1576,8 @@ public readonly isInline: boolean;
 
 - *Type:* `boolean`
 
+Determines whether this Code is inline code or not.
+
 ---
 
 
@@ -1799,7 +1590,7 @@ public readonly isInline: boolean;
 ```typescript
 import { JavaScriptSource } from '@mrgrain/cdk-esbuild'
 
-new JavaScriptSource(entryPoints: string | string[] | {[ key: string ]: string}, props?: EsbuildProps)
+new JavaScriptSource(entryPoints: string | string[] | {[ key: string ]: string}, props?: JavaScriptSourceProps)
 ```
 
 ##### `entryPoints`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptSource.parameter.entryPoints"></a>
@@ -1810,7 +1601,7 @@ new JavaScriptSource(entryPoints: string | string[] | {[ key: string ]: string},
 
 ##### `props`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptSource.parameter.props"></a>
 
-- *Type:* [`@mrgrain/cdk-esbuild.EsbuildProps`](#@mrgrain/cdk-esbuild.EsbuildProps)
+- *Type:* [`@mrgrain/cdk-esbuild.JavaScriptSourceProps`](#@mrgrain/cdk-esbuild.JavaScriptSourceProps)
 
 ---
 
@@ -1848,82 +1639,18 @@ public readonly assetClass: JavaScriptAsset;
 ---
 
 
-### LocalBundler <a name="@mrgrain/cdk-esbuild.LocalBundler"></a>
-
-- *Implements:* [`@aws-cdk/core.ILocalBundling`](#@aws-cdk/core.ILocalBundling)
-
-#### Initializers <a name="@mrgrain/cdk-esbuild.LocalBundler.Initializer"></a>
-
-```typescript
-import { LocalBundler } from '@mrgrain/cdk-esbuild'
-
-new LocalBundler(buildOptions: EsbuildOptions, props?: EsbuildBundlingProps)
-```
-
-##### `buildOptions`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.LocalBundler.parameter.buildOptions"></a>
-
-- *Type:* [`@mrgrain/cdk-esbuild.EsbuildOptions`](#@mrgrain/cdk-esbuild.EsbuildOptions)
-
----
-
-##### `props`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.LocalBundler.parameter.props"></a>
-
-- *Type:* [`@mrgrain/cdk-esbuild.EsbuildBundlingProps`](#@mrgrain/cdk-esbuild.EsbuildBundlingProps)
-
----
-
-#### Methods <a name="Methods"></a>
-
-##### `tryBundle` <a name="@mrgrain/cdk-esbuild.LocalBundler.tryBundle"></a>
-
-```typescript
-public tryBundle(outputDir: string, _options: BundlingOptions)
-```
-
-###### `outputDir`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.LocalBundler.parameter.outputDir"></a>
-
-- *Type:* `string`
-
----
-
-###### `_options`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.LocalBundler.parameter._options"></a>
-
-- *Type:* [`@aws-cdk/core.BundlingOptions`](#@aws-cdk/core.BundlingOptions)
-
----
-
-
-#### Properties <a name="Properties"></a>
-
-##### `buildOptions`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.LocalBundler.property.buildOptions"></a>
-
-```typescript
-public readonly buildOptions: EsbuildOptions;
-```
-
-- *Type:* [`@mrgrain/cdk-esbuild.EsbuildOptions`](#@mrgrain/cdk-esbuild.EsbuildOptions)
-
----
-
-##### `props`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.LocalBundler.property.props"></a>
-
-```typescript
-public readonly props: EsbuildBundlingProps;
-```
-
-- *Type:* [`@mrgrain/cdk-esbuild.EsbuildBundlingProps`](#@mrgrain/cdk-esbuild.EsbuildBundlingProps)
-
----
+### TypeScriptAsset <a name="@mrgrain/cdk-esbuild.TypeScriptAsset"></a>
 
+Bundles the entry points and creates a CDK asset which is uploaded to the bootstrapped CDK S3 bucket during deployment.
 
-### TypeScriptAsset <a name="@mrgrain/cdk-esbuild.TypeScriptAsset"></a>
+The asset can be used by other constructs.
 
 #### Initializers <a name="@mrgrain/cdk-esbuild.TypeScriptAsset.Initializer"></a>
 
 ```typescript
 import { TypeScriptAsset } from '@mrgrain/cdk-esbuild'
 
-new TypeScriptAsset(scope: Construct, id: string, __2: EsbuildAssetProps)
+new TypeScriptAsset(scope: Construct, id: string, props: AssetProps)
 ```
 
 ##### `scope`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptAsset.parameter.scope"></a>
@@ -1938,9 +1665,9 @@ new TypeScriptAsset(scope: Construct, id: string, __2: EsbuildAssetProps)
 
 ---
 
-##### `__2`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptAsset.parameter.__2"></a>
+##### `props`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptAsset.parameter.props"></a>
 
-- *Type:* [`@mrgrain/cdk-esbuild.EsbuildAssetProps`](#@mrgrain/cdk-esbuild.EsbuildAssetProps)
+- *Type:* [`@mrgrain/cdk-esbuild.AssetProps`](#@mrgrain/cdk-esbuild.AssetProps)
 
 ---
 
@@ -1950,23 +1677,36 @@ new TypeScriptAsset(scope: Construct, id: string, __2: EsbuildAssetProps)
 
 ### TypeScriptCode <a name="@mrgrain/cdk-esbuild.TypeScriptCode"></a>
 
+Represents the deployed TypeScript Code.
+
 #### Initializers <a name="@mrgrain/cdk-esbuild.TypeScriptCode.Initializer"></a>
 
 ```typescript
 import { TypeScriptCode } from '@mrgrain/cdk-esbuild'
 
-new TypeScriptCode(entryPoints: string | string[] | {[ key: string ]: string}, props?: EsbuildProps)
+new TypeScriptCode(entryPoints: string | string[] | {[ key: string ]: string}, props?: TypeScriptCodeProps)
 ```
 
 ##### `entryPoints`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptCode.parameter.entryPoints"></a>
 
 - *Type:* `string` | `string`[] | {[ key: string ]: `string`}
 
+A relative path or list or map of relative paths to the entry points of your code from the root of the project.
+
+E.g. `src/index.ts`.
+
 ---
 
 ##### `props`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptCode.parameter.props"></a>
 
-- *Type:* [`@mrgrain/cdk-esbuild.EsbuildProps`](#@mrgrain/cdk-esbuild.EsbuildProps)
+- *Type:* [`@mrgrain/cdk-esbuild.TypeScriptCodeProps`](#@mrgrain/cdk-esbuild.TypeScriptCodeProps)
+
+Props to change the behavior of the bundler.
+
+Default values for `props.buildOptions`:
+- `bundle=true`
+- `platform=node`
+- `target=nodeX` with X being the major node version running locally
 
 ---
 
@@ -2005,17 +1745,9 @@ public bindToResource(resource: CfnResource, options?: ResourceBindOptions)
 
 #### Properties <a name="Properties"></a>
 
-##### `assetClass`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptCode.property.assetClass"></a>
+##### ~~`isInline`~~<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptCode.property.isInline"></a>
 
-```typescript
-public readonly assetClass: TypeScriptAsset;
-```
-
-- *Type:* [`@mrgrain/cdk-esbuild.TypeScriptAsset`](#@mrgrain/cdk-esbuild.TypeScriptAsset)
-
----
-
-##### `isInline`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptCode.property.isInline"></a>
+- *Deprecated:* this value is ignored since inline is now determined based on the the inlineCode field of CodeConfig returned from bind().
 
 ```typescript
 public readonly isInline: boolean;
@@ -2023,6 +1755,8 @@ public readonly isInline: boolean;
 
 - *Type:* `boolean`
 
+Determines whether this Code is inline code or not.
+
 ---
 
 
@@ -2035,7 +1769,7 @@ public readonly isInline: boolean;
 ```typescript
 import { TypeScriptSource } from '@mrgrain/cdk-esbuild'
 
-new TypeScriptSource(entryPoints: string | string[] | {[ key: string ]: string}, props?: EsbuildProps)
+new TypeScriptSource(entryPoints: string | string[] | {[ key: string ]: string}, props?: TypeScriptSourceProps)
 ```
 
 ##### `entryPoints`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptSource.parameter.entryPoints"></a>
@@ -2046,7 +1780,7 @@ new TypeScriptSource(entryPoints: string | string[] | {[ key: string ]: string},
 
 ##### `props`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptSource.parameter.props"></a>
 
-- *Type:* [`@mrgrain/cdk-esbuild.EsbuildProps`](#@mrgrain/cdk-esbuild.EsbuildProps)
+- *Type:* [`@mrgrain/cdk-esbuild.TypeScriptSourceProps`](#@mrgrain/cdk-esbuild.TypeScriptSourceProps)
 
 ---