Typescriptify

Author: bendemboski

ember-add-listener-helper/rollup.config.mjs

@@ -18,7 +18,7 @@ export default {
   plugins: [
     // These are the modules that users should be able to import from your
     // addon. Anything not listed here may get optimized away.
-    addon.publicEntrypoints(['helpers/**/*.js', 'index.js', 'template-registry.js']),
+    addon.publicEntrypoints(['helpers/**/*.ts', 'template-registry.ts']),
 
     // These are the modules that should get reexported into the traditional
     // "app" tree. Things in here should also be in publicEntrypoints above, but

ember-add-listener-helper/src/helpers/add-listener.js

@@ -0,0 +1,52 @@
+import Helper from '@ember/component/helper';
+import { addListener, removeListener } from '@ember/object/events';
+
+// We define these explicitly rather than using `Parameters<typeof addListener>`
+// because `addListener`'s arguments were typed incorrectly in earlier preview
+// versions of Ember types.
+type PositionalArgs = [
+  obj?: object,
+  eventName?: string,
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  target?: object | Function | null,
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  method?: Function,
+  sync?: boolean
+];
+
+interface AddListenerHelperSignature {
+  Args: {
+    Positional: PositionalArgs;
+  };
+  Return: undefined;
+}
+
+export default class AddListenerHelper extends Helper<AddListenerHelperSignature> {
+  private removeListener?: () => void;
+
+  compute(args: PositionalArgs) {
+    this.checkRemoveListener();
+
+    const [obj, eventName, target, method, once] = args;
+    // method and once are optional
+    if (!obj || !eventName || !target) {
+      return undefined;
+    }
+
+    addListener(obj, eventName, target, method, once);
+    this.removeListener = () => removeListener(obj, eventName, target, method);
+    return undefined;
+  }
+
+  willDestroy() {
+    this.checkRemoveListener();
+    super.willDestroy();
+  }
+
+  checkRemoveListener() {
+    if (this.removeListener) {
+      this.removeListener();
+      delete this.removeListener;
+    }
+  }
+}

ember-add-listener-helper/src/helpers/add-listener.ts

@@ -0,0 +1,5 @@
+import type AddListenerHelper from './helpers/add-listener';
+
+export default interface EmberAddListenerHelperRegistry {
+  'add-listener': typeof AddListenerHelper;
+}

ember-add-listener-helper/src/template-registry.ts

@@ -35,6 +35,7 @@
     "@tsconfig/ember": "^3.0.0",
     "@types/qunit": "^2.19.6",
     "@types/rsvp": "^4.0.4",
+    "@types/sinon": "^10.0.15",
     "@typescript-eslint/eslint-plugin": "^5.57.1",
     "@typescript-eslint/parser": "^5.57.1",
     "broccoli-asset-rev": "^3.0.0",