feat: removing a single event listener / `Plugin#removeListener`

Feature Request

Description

Allow removing listeners on plugins selectively, instead of just removeAllListeners().

Platform(s)

Android, iOS, web

Preferred Solution

Add a removeListener(eventName: string, listenerFunc: ListenerCallback) method to all plugins that support addListener. The removeListener method already exists as private API on WebPlugin.

It expects an eventName and a stable listenerFunc reference. If the given pair is not currently registered, it no-ops.

Bonus points for adding { once: boolean } as an option to addListener.

Additional Context

https://github.com/ionic-team/capacitor/blob/a37e188bf1ab57465e86f6b2ab7c4c2308a21173/core/src/web/index.ts#L83-L108

https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener

https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener

[JMCollins]

Would this existing mechanism meet your needs? (Example In TypeScript)

const myPluginEventListener = Plugins.MyPlugin.addListener(
  'myPluginEvent',
  (info: any) => {
    console.log('myPluginEvent was fired');
  },
);

myPluginEventListener.remove();

See “Plugin Events” in: https://capacitorjs.com/docs/plugins/ios https://capacitorjs.com/docs/plugins/android

[JMCollins]

I am a first-time Capacitor user (not on the dev team). I am currently working on a plugin and happened to see your post while doing some research. Glad I could be helpful. Cheers.