v0.200

* add `unlisten()`
* now `listen()` do not returns a function to remove the listener

Author: luizbills

bun.lock

@@ -1,6 +1,6 @@
 {
     "name": "litecanvas",
-    "version": "0.103.7",
+    "version": "0.200.0",
     "description": "Lightweight HTML5 canvas 2D game engine suitable for small projects and creative coding. Inspired by PICO-8 and p5.js/Processing.",
     "license": "MIT",
     "author": "Luiz Bills <luizbills@pm.me>",
@@ -32,7 +32,7 @@
         "creative coding"
     ],
     "devDependencies": {
-        "@happy-dom/global-registrator": "^20.8.3",
+        "@happy-dom/global-registrator": "^20.8.4",
         "@size-limit/preset-small-lib": "^12.0.1",
         "@swc/core": "^1.15.18",
         "ava": "^7.0.0",

package.json

@@ -44,12 +44,13 @@ function pluginTest(engine, config) {
         console.log(`Tap detected in X=${x} Y=${y}`)
     })
 
-    // the `listen()` returns a function that when called removes that listener
-    // example: call this listencer once and then remove it
-    let deleteListener = engine.listen('update', () => {
+    engine.listen('update', updateOnce)
+    function updateOnce() {
         console.log('JUST ONE TIME!')
-        deleteListener()
-    })
+
+        // the `unlisten()` removes a event listener
+        engine.unlisten('update', updateOnce)
+    }
 
     // use `def()` to create or update that instance properties
     // example: create a variable named FOO

samples/plugin-basics/plugin-basics.js

@@ -1079,9 +1079,8 @@ export default function litecanvas(settings = {}) {
          *
          * @param {string} eventName the event type name
          * @param {Function} callback the function that is called when the event occurs
-         * @returns {Function} a function to remove the listener
          */
-        listen(eventName, callback) {
+        listen: (eventName, callback) => {
             DEV: assert(
                 'string' === typeof eventName,
                 loggerPrefix + 'listen() 1st param must be a string'
@@ -1095,9 +1094,29 @@ export default function litecanvas(settings = {}) {
 
             _eventListeners[eventName] = _eventListeners[eventName] || new Set()
             _eventListeners[eventName].add(callback)
+        },
+
+        /**
+         * Remove a game event listener
+         *
+         * @param {string} eventName the event type name
+         * @param {Function} callback the function that is called when the event occurs
+         */
+        unlisten: (eventName, callback) => {
+            DEV: assert(
+                'string' === typeof eventName,
+                loggerPrefix + 'unlisten() 1st param must be a string'
+            )
+            DEV: assert(
+                'function' === typeof callback,
+                loggerPrefix + 'unlisten() 2nd param must be a function'
+            )
+
+            eventName = lowerCase(eventName)
 
-            // return a function to remove this event listener
-            return () => _eventListeners[eventName]?.delete(callback)
+            if (_eventListeners[eventName]) {
+                _eventListeners[eventName].delete(callback)
+            }
         },
 
         /**

src/index.js

@@ -8,11 +8,11 @@ import { GlobalRegistrator } from '@happy-dom/global-registrator'
  */
 global.onLitecanvas = function (instance, event, callback) {
     return new Promise((resolve, reject) => {
-        const removeListener = instance.listen(event, (...args) => {
+        instance.listen(event, (...args) => {
             try {
                 const res = callback(...args)
                 if (false !== res) {
-                    removeListener()
+                    instance.unlisten(event, callback)
                     resolve()
                 }
             } catch (err) {

src/version.js

@@ -551,9 +551,15 @@ declare global {
      *
      * @param event The game event type
      * @param callback the function that is called when the event occurs
-     * @returns a function to remove the listener
      */
-    function listen(event: string, callback: Function): Function
+    function listen(event: string, callback: Function): void
+    /**
+     * Remove a game loop event listener
+     *
+     * @param event The game event type
+     * @param callback the function that is called when the event occurs
+     */
+    function unlisten(event: string, callback: Function): void
     /**
      * Call all listeners attached to a game event
      *

tests/_preload/happy-dom.js

@@ -535,9 +535,15 @@ type LitecanvasInstance = {
      *
      * @param event The game event type
      * @param callback the function that is called when the event occurs
-     * @returns a function to remove the listener
      */
-    listen(event: string, callback: Function): Function
+    listen(event: string, callback: Function): void
+    /**
+     * Remove a game loop event listener
+     *
+     * @param event The game event type
+     * @param callback the function that is called when the event occurs
+     */
+    unlisten(event: string, callback: Function): void
     /**
      * Call all listeners attached to a game event
      *