vue3-event-bus-plugin 1.0.2 → 1.0.3

package/dist/index.d.ts

@@ -0,0 +1,89 @@
+// Type definitions for vue3-event-bus-plugin
+// Project: https://github.com/fyh-mengxiang/vue3-plugins
+// Definitions by: fyh-mengxiang <fuyunhouazsj@aliyun.com>
+
+import { App } from 'vue';
+
+interface EventBusOptions {
+  enableCache?: boolean;
+  maxCacheSize?: number;
+  clearCacheAfterSubscribe?: boolean;
+}
+
+interface EventBus {
+  /**
+   * Subscribe to an event
+   * @param eventName Event name
+   * @param callback Callback function
+   * @param options Optional configuration
+   * @returns Unsubscribe function
+   */
+  on(eventName: string, callback: (...args: any[]) => void, options?: { once?: boolean }): () => void;
+
+  /**
+   * Subscribe to an event once
+   * @param eventName Event name
+   * @param callback Callback function
+   * @returns Unsubscribe function
+   */
+  once(eventName: string, callback: (...args: any[]) => void): () => void;
+
+  /**
+   * Unsubscribe from an event
+   * @param eventName Event name
+   * @param callback Optional callback function to unsubscribe
+   */
+  off(eventName: string, callback?: (...args: any[]) => void): void;
+
+  /**
+   * Emit an event
+   * @param eventName Event name
+   * @param args Arguments to pass to listeners
+   */
+  emit(eventName: string, ...args: any[]): void;
+
+  /**
+   * Get the number of listeners for an event
+   * @param eventName Event name
+   * @returns Number of listeners
+   */
+  listenerCount(eventName: string): number;
+
+  /**
+   * Get all event names
+   * @returns Array of event names
+   */
+  getEvents(): string[];
+
+  /**
+   * Clear all event listeners
+   */
+  clear(): void;
+}
+
+interface EventBusPluginOptions {
+  debug?: boolean;
+  eventBusOptions?: EventBusOptions;
+}
+
+interface EventBusPlugin {
+  install: (app: App, options?: EventBusPluginOptions) => void;
+}
+
+declare const eventBus: EventBus;
+
+declare class EventBusClass implements EventBus {
+  constructor(options?: EventBusOptions);
+  on(eventName: string, callback: (...args: any[]) => void, options?: { once?: boolean }): () => void;
+  once(eventName: string, callback: (...args: any[]) => void): () => void;
+  off(eventName: string, callback?: (...args: any[]) => void): void;
+  emit(eventName: string, ...args: any[]): void;
+  listenerCount(eventName: string): number;
+  getEvents(): string[];
+  clear(): void;
+}
+
+declare const _default: EventBusPlugin;
+
+export default _default;
+export { eventBus, EventBusClass as EventBus };

package/index.d.ts

@@ -0,0 +1,89 @@
+// Type definitions for vue3-event-bus-plugin
+// Project: https://github.com/fyh-mengxiang/vue3-plugins
+// Definitions by: fyh-mengxiang <fuyunhouazsj@aliyun.com>
+
+import { App } from 'vue';
+
+interface EventBusOptions {
+  enableCache?: boolean;
+  maxCacheSize?: number;
+  clearCacheAfterSubscribe?: boolean;
+}
+
+interface EventBus {
+  /**
+   * Subscribe to an event
+   * @param eventName Event name
+   * @param callback Callback function
+   * @param options Optional configuration
+   * @returns Unsubscribe function
+   */
+  on(eventName: string, callback: (...args: any[]) => void, options?: { once?: boolean }): () => void;
+
+  /**
+   * Subscribe to an event once
+   * @param eventName Event name
+   * @param callback Callback function
+   * @returns Unsubscribe function
+   */
+  once(eventName: string, callback: (...args: any[]) => void): () => void;
+
+  /**
+   * Unsubscribe from an event
+   * @param eventName Event name
+   * @param callback Optional callback function to unsubscribe
+   */
+  off(eventName: string, callback?: (...args: any[]) => void): void;
+
+  /**
+   * Emit an event
+   * @param eventName Event name
+   * @param args Arguments to pass to listeners
+   */
+  emit(eventName: string, ...args: any[]): void;
+
+  /**
+   * Get the number of listeners for an event
+   * @param eventName Event name
+   * @returns Number of listeners
+   */
+  listenerCount(eventName: string): number;
+
+  /**
+   * Get all event names
+   * @returns Array of event names
+   */
+  getEvents(): string[];
+
+  /**
+   * Clear all event listeners
+   */
+  clear(): void;
+}
+
+interface EventBusPluginOptions {
+  debug?: boolean;
+  eventBusOptions?: EventBusOptions;
+}
+
+interface EventBusPlugin {
+  install: (app: App, options?: EventBusPluginOptions) => void;
+}
+
+declare const eventBus: EventBus;
+
+declare class EventBusClass implements EventBus {
+  constructor(options?: EventBusOptions);
+  on(eventName: string, callback: (...args: any[]) => void, options?: { once?: boolean }): () => void;
+  once(eventName: string, callback: (...args: any[]) => void): () => void;
+  off(eventName: string, callback?: (...args: any[]) => void): void;
+  emit(eventName: string, ...args: any[]): void;
+  listenerCount(eventName: string): number;
+  getEvents(): string[];
+  clear(): void;
+}
+
+declare const _default: EventBusPlugin;
+
+export default _default;
+export { eventBus, EventBusClass as EventBus };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue3-event-bus-plugin",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A simple and lightweight EventBus for Vue 3, supporting both Composition API and Option API",
   "type": "module",
   "scripts": {
@@ -12,7 +12,8 @@
   "module": "dist/vue3-event-bus-plugin.es.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "index.d.ts"
   ],
   "keywords": [
     "vue3-event-bus-plugin",
@@ -28,10 +29,13 @@
     "vue": "^3.0.0"
   },
   "devDependencies": {
+    "@types/node": "^25.0.3",
     "@vitejs/plugin-vue": "^6.0.3",
     "rollup-plugin-terser": "^7.0.2",
+    "typescript": "^5.9.3",
     "vite": "^7.3.0",
-    "vue": "^3.0.0"
+    "vue": "^3.0.0",
+    "vue-tsc": "^3.2.1"
   },
   "repository": {
     "type": "git",