Skip to content
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 3 commits into from
Apr 27, 2023
Merged

feat(ui): Add type support for EventBus class #15759

merged 3 commits into from
Apr 27, 2023

Conversation

marvin-wtt
Copy link
Contributor

This PR makes it possible to strictly type events for the EventBus class.
Example from docs:

import { EventBus } from 'quasar'

const bus = new EventBus<{
    'some-event': (arg1: string, arg2: string, arg3: string) => void;
    other: (arg: boolean) => void;
}>()

bus.emit('some-event', 'arg1 value', 'arg2 value', 'arg3 value')

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Documentation
  • Code style update
  • Refactor
  • Build-related changes
  • Other, please describe:

Does this PR introduce a breaking change?

  • Yes
  • No

The PR fulfills these requirements:

  • It's submitted to the dev branch (or v[X] branch)
  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix: #xxx[,#xxx], where "xxx" is the issue number)
  • It's been tested on a Cordova (iOS, Android) app
  • It's been tested on an Electron app
  • Any necessary documentation has been added or updated in the docs or explained in the PR's description.

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to start a new feature discussion first and wait for approval before working on it)

Other information:

@rstoenescu rstoenescu merged commit 8d8fa8b into quasarframework:dev Apr 27, 2023
1 check passed
@rstoenescu
Copy link
Member

Thanks for contributing!
This will go into Quasar v2.11.11

@github-actions
Copy link

Build Results

JSON 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 {

ui/types/utils.d.ts Show resolved Hide resolved
ui/types/utils.d.ts Show resolved Hide resolved
ui/types/utils.d.ts Show resolved Hide resolved
docs/src/pages/quasar-utils/event-bus-util.md Show resolved Hide resolved
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants