Skip to content

Commit ed514b5

Browse files
5.0.0
1 parent 678a51e commit ed514b5

16 files changed

+34
-31
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
77

88
## [Unreleased]
99

10+
## [5.0.0] - 2021-02-09
11+
1012
### Changed
1113
- Updated interface of `BundleOrchestrator._transform` reflecting tighter constraints in `@types/node` v14. No modification to runtime logic, method only used by NodeJS streams.
1214
- Removed `esm` loader in favour of native ESM support.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export interface Bundle
1616

1717
| Property | Type | Description |
1818
| --- | --- | --- |
19-
| [options](./gulp-bundle-assets.bundle.options.md) | <code>Options</code> | |
20-
| [scripts](./gulp-bundle-assets.bundle.scripts.md) | <code>string[]</code> | |
21-
| [styles](./gulp-bundle-assets.bundle.styles.md) | <code>string[]</code> | |
19+
| [options?](./gulp-bundle-assets.bundle.options.md) | [Options](./gulp-bundle-assets.options.md) | <i>(Optional)</i> |
20+
| [scripts?](./gulp-bundle-assets.bundle.scripts.md) | string\[\] | <i>(Optional)</i> |
21+
| [styles?](./gulp-bundle-assets.bundle.styles.md) | string\[\] | <i>(Optional)</i> |
2222

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ constructor(config: Config, joiner: Bundlers, resultsCallback?: ResultsCallback)
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| config | <code>Config</code> | Raw (but valid) configuration file used for bundle resolution. |
20-
| joiner | <code>Bundlers</code> | Object capable of generating the Transform streams needed for generation of final bundles. |
21-
| resultsCallback | <code>ResultsCallback</code> | Callback invoked once all bundles generated. |
19+
| config | [Config](./gulp-bundle-assets.config.md) | Raw (but valid) configuration file used for bundle resolution. |
20+
| joiner | [Bundlers](./gulp-bundle-assets.bundlers.md) | Object capable of generating the Transform streams needed for generation of final bundles. |
21+
| resultsCallback | [ResultsCallback](./gulp-bundle-assets.resultscallback.md) | Callback invoked once all bundles generated. |
2222

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ _flush(callback: TransformCallback): Promise<void>;
1414

1515
| Parameter | Type | Description |
1616
| --- | --- | --- |
17-
| callback | <code>TransformCallback</code> | |
17+
| callback | TransformCallback | |
1818

1919
<b>Returns:</b>
2020

21-
`Promise<void>`
21+
Promise&lt;void&gt;
2222

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@ Collects copies of applicable files to later bundle.
99
<b>Signature:</b>
1010

1111
```typescript
12-
_transform(chunk: any, encoding: string, callback: TransformCallback): Promise<void>;
12+
_transform(chunk: any, encoding: BufferEncoding, callback: TransformCallback): Promise<void>;
1313
```
1414

1515
## Parameters
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| chunk | <code>any</code> | Stream chunk, may be a Vinyl object. |
20-
| encoding | <code>string</code> | Encoding of chunk, if applicable. |
21-
| callback | <code>TransformCallback</code> | Callback to indicate processing is completed. |
19+
| chunk | any | Stream chunk, may be a Vinyl object. |
20+
| encoding | BufferEncoding | Encoding of chunk, if applicable. |
21+
| callback | TransformCallback | Callback to indicate processing is completed. |
2222

2323
<b>Returns:</b>
2424

25-
`Promise<void>`
25+
Promise&lt;void&gt;
2626

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Orchestrates bundling.
1111
```typescript
1212
export declare class BundleOrchestrator extends Transform
1313
```
14+
<b>Extends:</b> Transform
1415
1516
## Constructors
1617

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ export interface Bundlers
1616

1717
| Property | Type | Description |
1818
| --- | --- | --- |
19-
| [Scripts](./gulp-bundle-assets.bundlers.scripts.md) | <code>BundleStreamFactory</code> | Returns a Transform that will handle bundling of script resources. |
20-
| [Styles](./gulp-bundle-assets.bundlers.styles.md) | <code>BundleStreamFactory</code> | Returns a Transform that will handle bundling of style resources. |
19+
| [Scripts](./gulp-bundle-assets.bundlers.scripts.md) | [BundleStreamFactory](./gulp-bundle-assets.bundlestreamfactory.md) | Returns a Transform that will handle bundling of script resources. |
20+
| [Styles](./gulp-bundle-assets.bundlers.styles.md) | [BundleStreamFactory](./gulp-bundle-assets.bundlestreamfactory.md) | Returns a Transform that will handle bundling of style resources. |
2121

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Optional logger that will be used throughout bundling process.
99
<b>Signature:</b>
1010

1111
```typescript
12-
Logger?: Logger;
12+
Logger?: TsLog.Logger;
1313
```

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export interface Config
1616

1717
| Property | Type | Description |
1818
| --- | --- | --- |
19-
| [bundle](./gulp-bundle-assets.config.bundle.md) | <code>Bundles</code> | Bundle definitions. |
20-
| [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>. |
21-
| [Logger](./gulp-bundle-assets.config.logger.md) | <code>Logger</code> | Optional logger that will be used throughout bundling process. |
19+
| [bundle?](./gulp-bundle-assets.config.bundle.md) | [Bundles](./gulp-bundle-assets.bundles.md) | <i>(Optional)</i> Bundle definitions. |
20+
| [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>. |
21+
| [Logger?](./gulp-bundle-assets.config.logger.md) | TsLog.Logger | <i>(Optional)</i> Optional logger that will be used throughout bundling process. |
2222

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ Merges a collection of configurations. No validation is conducted, it is expecte
1111
<b>Signature:</b>
1212

1313
```typescript
14-
export default function MergeConfigs(rawConfigs: Config[]): Config;
14+
export declare function MergeConfigs(rawConfigs: Config[]): Config;
1515
```
1616

1717
## Parameters
1818

1919
| Parameter | Type | Description |
2020
| --- | --- | --- |
21-
| rawConfigs | <code>Config[]</code> | Raw (untransformed) configurations to merge. |
21+
| rawConfigs | [Config](./gulp-bundle-assets.config.md)<!-- -->\[\] | Raw (untransformed) configurations to merge. |
2222

2323
<b>Returns:</b>
2424

25-
`Config`
25+
[Config](./gulp-bundle-assets.config.md)
2626

0 commit comments

Comments
 (0)