4.0.0-alpha.1

Author: Silic0nS0ldier

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [4.0.0-alpha.1] - 2020-01-23
+
 This release focuses on improving performance and maintainability. These have been achieved by separating virtual path logic into a separate package.
 
 ### Added

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

@@ -4,7 +4,7 @@
 
 ## BundleOrchastrator.(constructor)
 
- Finish docblock
+Constructs a new instance of the `BundleOrchastrator` class
 
 <b>Signature:</b>
 
@@ -18,5 +18,5 @@ constructor(config: Config, joiner: Bundlers, resultsCallback?: ResultsCallback)
 |  --- | --- | --- |
 |  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> | TODO |
+|  resultsCallback | <code>ResultsCallback</code> | Callback invoked once all bundles generated. |
 

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

@@ -16,7 +16,7 @@ export declare class BundleOrchastrator extends Transform
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(config, joiner, resultsCallback)](./gulp-bundle-assets.bundleorchastrator._constructor_.md) |  |  Finish docblock |
+|  [(constructor)(config, joiner, resultsCallback)](./gulp-bundle-assets.bundleorchastrator._constructor_.md) |  | Constructs a new instance of the <code>BundleOrchastrator</code> class |
 
 ## Methods
 

docs/api/gulp-bundle-assets.md

@@ -20,7 +20,7 @@
 
 |  Function | Description |
 |  --- | --- |
-|  [MergeRawConfigs(rawConfigs)](./gulp-bundle-assets.mergerawconfigs.md) |  Finish docblock Merges a collection of configurations. No validation is conducted, it is expected that provided inputs are all valid.<code>bundle-&gt;(BundleName)-&gt;options-&gt;sprinkle-&gt;onCollision = (replace&#124;merge&#124;ignore&#124;error)</code> may be used to modify treatment of collided bundles. |
+|  [MergeRawConfigs(rawConfigs)](./gulp-bundle-assets.mergerawconfigs.md) | Merges a collection of configurations. No validation is conducted, it is expected that provided inputs are all valid.<code>bundle-&gt;(BundleName)-&gt;options-&gt;sprinkle-&gt;onCollision = (replace&#124;merge&#124;ignore&#124;error)</code> may be used to modify treatment of collided bundles. |
 |  [ValidateRawConfig(config)](./gulp-bundle-assets.validaterawconfig.md) | Throws an exception if the provided raw config contains invalid data. |
 
 ## Interfaces
@@ -33,7 +33,7 @@
 |  [BundleStreamFactory](./gulp-bundle-assets.bundlestreamfactory.md) | A function that returns a stream that will be used to bundle assets. |
 |  [Config](./gulp-bundle-assets.config.md) | Root object of raw configuration. |
 |  [Options](./gulp-bundle-assets.options.md) | Represents an asset bundles root options node. |
-|  [Results](./gulp-bundle-assets.results.md) |  Finish docblock |
-|  [ResultsCallback](./gulp-bundle-assets.resultscallback.md) |  Finish docblock |
+|  [Results](./gulp-bundle-assets.results.md) | Bundler results data shape. |
+|  [ResultsCallback](./gulp-bundle-assets.resultscallback.md) | Bundler results callback function interface. |
 |  [SprinkleOptions](./gulp-bundle-assets.sprinkleoptions.md) | Options relevent to UserFrosting's Sprinkle system. |
 

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

@@ -4,7 +4,7 @@
 
 ## MergeRawConfigs() function
 
- Finish docblock Merges a collection of configurations. No validation is conducted, it is expected that provided inputs are all valid.
+Merges a collection of configurations. No validation is conducted, it is expected that provided inputs are all valid.
 
 `bundle->(BundleName)->options->sprinkle->onCollision = (replace|merge|ignore|error)` may be used to modify treatment of collided bundles.
 
@@ -18,7 +18,7 @@ export default function MergeConfigs(rawConfigs: Config[]): Config;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  rawConfigs | <code>Config[]</code> | TODO |
+|  rawConfigs | <code>Config[]</code> | Raw (untransformed) configurations to merge. |
 
 <b>Returns:</b>
 

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

@@ -4,7 +4,7 @@
 
 ## Results interface
 
- Finish docblock
+Bundler results data shape.
 
 <b>Signature:</b>
 

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

@@ -4,7 +4,7 @@
 
 ## ResultsCallback interface
 
- Finish docblock
+Bundler results callback function interface.
 
 <b>Signature:</b>
 

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>CollisionReactions &#124; string</code> | How a bundle collision should be handled when bundles are being merged. |
+|  [onCollision](./gulp-bundle-assets.sprinkleoptions.oncollision.md) | <code>keyof typeof CollisionReactions</code> | How a bundle collision should be handled when bundles are being merged. |
 

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

@@ -9,5 +9,5 @@ How a bundle collision should be handled when bundles are being merged.
 <b>Signature:</b>
 
 ```typescript
-onCollision?: CollisionReactions | string;
+onCollision?: keyof typeof CollisionReactions;
 ```