5.0.0

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [5.0.0] - 2021-02-09
+
 ### Changed
 - Updated interface of `BundleOrchestrator._transform` reflecting tighter constraints in `@types/node` v14. No modification to runtime logic, method only used by NodeJS streams.
 - Removed `esm` loader in favour of native ESM support.

docs/api/gulp-bundle-assets.bundle.md

@@ -16,7 +16,7 @@ export interface Bundle
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [options](./gulp-bundle-assets.bundle.options.md) | <code>Options</code> |  |
-|  [scripts](./gulp-bundle-assets.bundle.scripts.md) | <code>string[]</code> |  |
-|  [styles](./gulp-bundle-assets.bundle.styles.md) | <code>string[]</code> |  |
+|  [options?](./gulp-bundle-assets.bundle.options.md) | [Options](./gulp-bundle-assets.options.md) | <i>(Optional)</i> |
+|  [scripts?](./gulp-bundle-assets.bundle.scripts.md) | string\[\] | <i>(Optional)</i> |
+|  [styles?](./gulp-bundle-assets.bundle.styles.md) | string\[\] | <i>(Optional)</i> |
 

docs/api/gulp-bundle-assets.bundleorchestrator._constructor_.md

@@ -16,7 +16,7 @@ constructor(config: Config, joiner: Bundlers, resultsCallback?: ResultsCallback)
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  config | <code>Config</code> | Raw (but valid) configuration file used for bundle resolution. |
-|  joiner | <code>Bundlers</code> | Object capable of generating the Transform streams needed for generation of final bundles. |
-|  resultsCallback | <code>ResultsCallback</code> | Callback invoked once all bundles generated. |
+|  config | [Config](./gulp-bundle-assets.config.md) | Raw (but valid) configuration file used for bundle resolution. |
+|  joiner | [Bundlers](./gulp-bundle-assets.bundlers.md) | Object capable of generating the Transform streams needed for generation of final bundles. |
+|  resultsCallback | [ResultsCallback](./gulp-bundle-assets.resultscallback.md) | Callback invoked once all bundles generated. |
 

docs/api/gulp-bundle-assets.bundleorchestrator._flush.md

@@ -14,9 +14,9 @@ _flush(callback: TransformCallback): Promise<void>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  callback | <code>TransformCallback</code> |  |
+|  callback | TransformCallback |  |
 
 <b>Returns:</b>
 
-`Promise<void>`
+Promise&lt;void&gt;
 

docs/api/gulp-bundle-assets.bundleorchestrator._transform.md

@@ -9,18 +9,18 @@ Collects copies of applicable files to later bundle.
 <b>Signature:</b>
 
 ```typescript
-_transform(chunk: any, encoding: string, callback: TransformCallback): Promise<void>;
+_transform(chunk: any, encoding: BufferEncoding, callback: TransformCallback): Promise<void>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  chunk | <code>any</code> | Stream chunk, may be a Vinyl object. |
-|  encoding | <code>string</code> | Encoding of chunk, if applicable. |
-|  callback | <code>TransformCallback</code> | Callback to indicate processing is completed. |
+|  chunk | any | Stream chunk, may be a Vinyl object. |
+|  encoding | BufferEncoding | Encoding of chunk, if applicable. |
+|  callback | TransformCallback | Callback to indicate processing is completed. |
 
 <b>Returns:</b>
 
-`Promise<void>`
+Promise&lt;void&gt;
 

docs/api/gulp-bundle-assets.bundleorchestrator.md

@@ -11,6 +11,7 @@ Orchestrates bundling.
 ```typescript
 export declare class BundleOrchestrator extends Transform 
 ```
+<b>Extends:</b> Transform
 
 ## Constructors
 

docs/api/gulp-bundle-assets.bundlers.md

@@ -16,6 +16,6 @@ export interface Bundlers
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [Scripts](./gulp-bundle-assets.bundlers.scripts.md) | <code>BundleStreamFactory</code> | Returns a Transform that will handle bundling of script resources. |
-|  [Styles](./gulp-bundle-assets.bundlers.styles.md) | <code>BundleStreamFactory</code> | Returns a Transform that will handle bundling of style resources. |
+|  [Scripts](./gulp-bundle-assets.bundlers.scripts.md) | [BundleStreamFactory](./gulp-bundle-assets.bundlestreamfactory.md) | Returns a Transform that will handle bundling of script resources. |
+|  [Styles](./gulp-bundle-assets.bundlers.styles.md) | [BundleStreamFactory](./gulp-bundle-assets.bundlestreamfactory.md) | Returns a Transform that will handle bundling of style resources. |
 

docs/api/gulp-bundle-assets.config.logger.md

@@ -9,5 +9,5 @@ Optional logger that will be used throughout bundling process.
 <b>Signature:</b>
 
 ```typescript
-Logger?: Logger;
+Logger?: TsLog.Logger;
 ```

docs/api/gulp-bundle-assets.config.md

@@ -16,7 +16,7 @@ export interface Config
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [bundle](./gulp-bundle-assets.config.bundle.md) | <code>Bundles</code> | Bundle definitions. |
-|  [cwd](./gulp-bundle-assets.config.cwd.md) | <code>string</code> | Current working directory to use when resolving the full paths of bundle dependencies. Defaults to <code>process.cwd()</code>. |
-|  [Logger](./gulp-bundle-assets.config.logger.md) | <code>Logger</code> | Optional logger that will be used throughout bundling process. |
+|  [bundle?](./gulp-bundle-assets.config.bundle.md) | [Bundles](./gulp-bundle-assets.bundles.md) | <i>(Optional)</i> Bundle definitions. |
+|  [cwd?](./gulp-bundle-assets.config.cwd.md) | string | <i>(Optional)</i> Current working directory to use when resolving the full paths of bundle dependencies. Defaults to <code>process.cwd()</code>. |
+|  [Logger?](./gulp-bundle-assets.config.logger.md) | TsLog.Logger | <i>(Optional)</i> Optional logger that will be used throughout bundling process. |
 

docs/api/gulp-bundle-assets.mergerawconfigs.md

@@ -11,16 +11,16 @@ Merges a collection of configurations. No validation is conducted, it is expecte
 <b>Signature:</b>
 
 ```typescript
-export default function MergeConfigs(rawConfigs: Config[]): Config;
+export declare function MergeConfigs(rawConfigs: Config[]): Config;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  rawConfigs | <code>Config[]</code> | Raw (untransformed) configurations to merge. |
+|  rawConfigs | [Config](./gulp-bundle-assets.config.md)<!-- -->\[\] | Raw (untransformed) configurations to merge. |
 
 <b>Returns:</b>
 
-`Config`
+[Config](./gulp-bundle-assets.config.md)
 

docs/api/gulp-bundle-assets.options.md

@@ -16,5 +16,5 @@ export interface Options
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [sprinkle](./gulp-bundle-assets.options.sprinkle.md) | <code>SprinkleOptions</code> |  |
+|  [sprinkle?](./gulp-bundle-assets.options.sprinkle.md) | [SprinkleOptions](./gulp-bundle-assets.sprinkleoptions.md) | <i>(Optional)</i> |
 

docs/api/gulp-bundle-assets.results.md

@@ -16,6 +16,6 @@ export interface Results
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [scripts](./gulp-bundle-assets.results.scripts.md) | <code>Map&lt;string, Vinyl[]&gt;</code> |  |
-|  [styles](./gulp-bundle-assets.results.styles.md) | <code>Map&lt;string, Vinyl[]&gt;</code> |  |
+|  [scripts](./gulp-bundle-assets.results.scripts.md) | Map&lt;string, Vinyl\[\]&gt; |  |
+|  [styles](./gulp-bundle-assets.results.styles.md) | Map&lt;string, Vinyl\[\]&gt; |  |
 

docs/api/gulp-bundle-assets.sprinkleoptions.md

@@ -16,5 +16,5 @@ export interface SprinkleOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [onCollision](./gulp-bundle-assets.sprinkleoptions.oncollision.md) | <code>keyof typeof CollisionReactions</code> | How a bundle collision should be handled when bundles are being merged. |
+|  [onCollision?](./gulp-bundle-assets.sprinkleoptions.oncollision.md) | keyof typeof [CollisionReactions](./gulp-bundle-assets.collisionreactions.md) | <i>(Optional)</i> How a bundle collision should be handled when bundles are being merged. |
 

docs/api/gulp-bundle-assets.validaterawconfig.md

@@ -9,16 +9,16 @@ Throws an exception if the provided raw config contains invalid data.
 <b>Signature:</b>
 
 ```typescript
-export default function ValidateConfig(config: Config): void;
+export declare function ValidateConfig(config: Config): void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  config | <code>Config</code> | Raw configuration to validate. |
+|  config | [Config](./gulp-bundle-assets.config.md) | Raw configuration to validate. |
 
 <b>Returns:</b>
 
-`void`
+void
 

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@userfrosting/gulp-bundle-assets",
-    "version": "4.0.1",
+    "version": "5.0.0",
     "description": "Orchestrates JS and CSS bundle creation in an efficient and configurable manner.",
     "funding": "https://opencollective.com/userfrosting",
     "type": "module",