Skip to content

Commit

Permalink
[Release] Increase version to 0.3.0 (#83)
Browse files Browse the repository at this point in the history
  • Loading branch information
nev21 authored Aug 18, 2023
1 parent 655ab2c commit 179562a
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 3 deletions.
9 changes: 9 additions & 0 deletions CHANGELIST.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion lib/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 179562a

Please sign in to comment.