Skip to content

Commit 4d9408a

Browse files
committed
Update README for v2.0.1 release
1 parent 32a472f commit 4d9408a

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog]
55
and this project adheres to [Semantic Versioning].
66

7+
## [2.0.1] - 2021-01-24
8+
### Changes
9+
- `events` helper functions depreciated. See [#8].
10+
- This is a maintenance release to fix the npm versions before v3.0 release.
11+
712
## [2.0.0] - 2020-05-18
813
### Changes
914
- Rename TypeScript interfaces `IEvents` and `IEventsFunction` to `Events` and `EventsFunction` respectively.
@@ -44,4 +49,6 @@ and this project adheres to [Semantic Versioning].
4449
[1.1.0]: https://github.com/JacobFischer/ts-typed-events/releases/tag/v1.1.0
4550
[1.1.1]: https://github.com/JacobFischer/ts-typed-events/releases/tag/v1.1.1
4651
[2.0.0]: https://github.com/JacobFischer/ts-typed-events/releases/tag/v2.0.0
52+
[2.0.1]: https://github.com/JacobFischer/ts-typed-events/releases/tag/v2.0.1
4753
[#6]: https://github.com/JacobFischer/ts-typed-events/issues/6
54+
[#8]: https://github.com/JacobFischer/ts-typed-events/issues/8

src/events.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ export interface EventsFunction {
5656
*
5757
* Returns a frozen object of events for easy grouping.
5858
*
59+
* @deprecated - see https://github.com/JacobFischer/ts-typed-events/issues/8.
5960
* @param group - An object of events used to group the event by name.
6061
* @returns A frozen object of events for easy grouping.
6162
*/

0 commit comments

Comments
 (0)