-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(ui): Add type support for EventBus class #15759
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Thanks for contributing! |
Build ResultsJSON API📜 No changes detected. Types📜 Changes detected: diff --git a/./current-build/types/index.d.ts b/./pr-build/types/index.d.ts
index 3a5a2d9..ddafdeb 100644
--- a/./current-build/types/index.d.ts
+++ b/./pr-build/types/index.d.ts
@@ -14155,6 +14155,7 @@ declare module "./lang" {
lt: true;
lu: true;
lv: true;
+ mk: true;
ml: true;
mm: true;
ms: true;
diff --git a/./current-build/types/utils.d.ts b/./pr-build/types/utils.d.ts
index 2b8f6ff..38dff7a 100644
--- a/./current-build/types/utils.d.ts
+++ b/./pr-build/types/utils.d.ts
@@ -103,11 +103,15 @@ export function setCssVar(
element?: Element
): void;
-export class EventBus {
- on(event: string, callback: Function, ctx?: any): this;
- once(event: string, callback: Function, ctx?: any): this;
- emit(event: string, ...args: any[]): this;
- off(event: string, callback?: Function): this;
+interface Callbacks {
+ [key: string]: (...args: any[]) => void;
+}
+
+export class EventBus<T extends Callbacks> {
+ on<K extends keyof T>(event: K, callback: T[K], ctx?: any): this;
+ once<K extends keyof T>(event: K, callback: T[K], ctx?: any): this;
+ emit<K extends keyof T>(event: K, ...args: Parameters<T[K]>): this;
+ off<K extends keyof T>(event: K, callback: T[K]): this;
}
interface CreateMetaMixinContext extends ComponentPublicInstance { |
15 tasks
rstoenescu
added a commit
that referenced
this pull request
Apr 28, 2023
* fix(ui): Make off method optional again * fix(ui): Fix naming in docs * feat(ui): Improve ctx type of EventBus * Update event-bus-util.md --------- Co-authored-by: Yusuf Kandemir <yusuf.kandemir@outlook.com.tr> Co-authored-by: Razvan Stoenescu <razvan.stoenescu@gmail.com>
rstoenescu
added a commit
that referenced
this pull request
Apr 28, 2023
* fix(ui): Make off method optional again * fix(ui): Fix naming in docs * feat(ui): Improve ctx type of EventBus * Update event-bus-util.md --------- Co-authored-by: Yusuf Kandemir <yusuf.kandemir@outlook.com.tr> Co-authored-by: Razvan Stoenescu <razvan.stoenescu@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes it possible to strictly type events for the
EventBus
class.Example from docs:
What kind of change does this PR introduce?
Does this PR introduce a breaking change?
The PR fulfills these requirements:
dev
branch (orv[X]
branch)fix: #xxx[,#xxx]
, where "xxx" is the issue number)If adding a new feature, the PR's description includes:
Other information: