diff --git a/CHANGELIST.md b/CHANGELIST.md index 56cac8e..e576543 100644 --- a/CHANGELIST.md +++ b/CHANGELIST.md @@ -1,3 +1,12 @@ +# v0.3.0 Aug 17th, 2023 + +## Changelog + +- #79 [Bug] remove typescript should not be a peer dependency +- #82 Bump @nevware21/ts-utils to minimum of 0.10.0 +- #81 Bump @microsoft/rush to 5.102.0 +- #74 Bump @typescript-eslint/eslint-plugin from 5.62.0 to 6.1.0 + # v0.2.6 June 12th, 2023 ## Changelog diff --git a/README.md b/README.md index 86154de..03c3e31 100644 --- a/README.md +++ b/README.md @@ -66,10 +66,29 @@ All implementations will "emit/dispatch" the unhandled promise rejections event The package provides a simple polyfill wrapper which is built around the `asynchronous` promise implementation which is tested and validated against the standard native (`Promise()`) implementations for node, browser and web-worker to ensure compatibility. +## Language ECMAScript Support + +### ES5 + +This library plans to maintain ES5 compatibility for all versions of v0.x and v1.x releases + +### ES(future [6 next, etc]) + +Future versions of this library starting at version 2.x are planned to lift and remove the internal polyfills to support the new targetted baseline once it is defined. +ie. It may or may not be ES6 depending on the runtime landscape and requests received. + +When we release v2.x the supported browser matrix will also shift as required to match the defined language level supported at that time. + ## Quickstart Install the npm packare: `npm install @nevware21/ts-async --save` +> It is suggested / recommended that you use the following definition in your `package.json` so that you are compatible with any future releases as they become available +> we do not intend to make ANY known breaking changes moving forward until v2.x +> ```json +> "@nevware21/ts-async": ">= 0.3.0 < 2.x" +> ``` + And then just import the helpers and use them. ### Simple Examples @@ -158,7 +177,7 @@ While the examples above are using the `createPromise` you can directly use the ## Browser Support -General support is currently set to ES5 supported runtimes higher. +General support is currently set to ES5 supported runtimes and higher. Internal polyfills are used to backfill ES5 functionality which is not provided by older browsers. diff --git a/lib/package.json b/lib/package.json index afb6a0f..158dd2c 100644 --- a/lib/package.json +++ b/lib/package.json @@ -1,7 +1,7 @@ { "name": "@nevware21/ts-async", "description": "support for asynchronous development with a Promise based task Scheduler, several different Promise implementations (synchronous, idle, asynchronous and native runtime wrappers), await helpers, and aliases all built and tested using TypeScript.", - "version": "0.2.6", + "version": "0.3.0", "homepage": "https://github.com/nevware21/ts-async", "sideEffects": false, "license": "MIT", diff --git a/package.json b/package.json index 7060ad3..ffd6aab 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@nevware21/ts-async", "description": "support for asynchronous development with a Promise based task Scheduler, several different Promise implementations (synchronous, idle, asynchronous and native runtime wrappers), await helpers, and aliases all built and tested using TypeScript.", - "version": "0.2.6", + "version": "0.3.0", "homepage": "https://github.com/nevware21/ts-async", "sideEffects": false, "license": "MIT",