💥 add TypeScript definitions (fixes #6)(#11)

index.d.ts

@@ -0,0 +1,40 @@
+import { 
+    Event, 
+    EventTarget, 
+    AddEventListenerOptions, 
+    EventListenerOptions,
+    EventTargetListener
+ } from "event-target-shim";
+
+export as namespace AbortControllerShim;
+
+export type AbortSignalListener = (this: AbortSignal, ev: any) => any;
+
+export class AbortSignal extends EventTarget {
+    private constructor();
+
+    /**
+     * Returns true if this AbortSignal's AbortController has signaled to abort, and false
+     * otherwise.
+     */
+    readonly aborted: boolean;
+    onabort: AbortSignalListener | null;
+    addEventListener(type: "abort", listener: AbortSignalListener, options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: string, listener: EventTargetListener | null, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener(type: "abort", listener: AbortSignalListener, options?: boolean | EventListenerOptions): void;
+    removeEventListener(type: string, listener: EventTargetListener | null, options?: boolean | EventListenerOptions): void;
+}
+
+export class AbortController {
+    /**
+     * Returns the AbortSignal object associated with this object.
+     */
+    readonly signal: AbortSignal;
+
+    /**
+     * Invoking this method will set this object's AbortSignal's aborted flag and
+     * signal to any observers that the associated activity is to be aborted.
+     */
+    abort(): void;
+}
+export default AbortController;

package.json

@@ -3,9 +3,11 @@
   "version": "1.1.0",
   "description": "An implementation of WHATWG AbortController interface.",
   "main": "dist/abort-controller",
+  "types": "index.d.ts",
   "files": [
     "dist",
-    "polyfill.*"
+    "polyfill.*",
+    "index.d.ts"
   ],
   "engines": {
     "node": ">=6.5"
@@ -40,7 +42,8 @@
     "rollup-plugin-commonjs": "^9.2.0",
     "rollup-plugin-json": "^3.1.0",
     "rollup-plugin-node-resolve": "^3.4.0",
-    "rollup-watch": "^4.3.1"
+    "rollup-watch": "^4.3.1",
+    "typescript": "^3.2.1"
   },
   "scripts": {
     "preversion": "npm test",
@@ -53,6 +56,7 @@
     "test": "run-s -s lint test:*",
     "test:mocha": "nyc --require ./scripts/babel-register.js mocha test/*.mjs",
     "test:karma": "karma start scripts/karma.conf.js --single-run",
+    "test:types": "tsc",
     "watch": "run-p -s watch:*",
     "watch:mocha": "mocha test/*.mjs --require ./scripts/babel-register.js --watch --watch-extensions js,mjs --growl",
     "watch:karma": "karma start scripts/karma.conf.js --watch",

test/types.ts

@@ -0,0 +1,30 @@
+import { AbortController as AbortControllerShim, AbortSignal as AbortSignalShim } from "..";
+
+function signalCallback(as: AbortSignal) { }
+function signalShimCallback(as: AbortSignalShim) { }
+function controllerCallback(ac: AbortController) { }
+function controllerShimCallback(ac: AbortControllerShim) { }
+function abortCallback(this: AbortSignal, ev: Event) { }
+
+const controller = new AbortController();
+const controllerShim = new AbortControllerShim();
+const signal = controller.signal;
+const signalShim = controllerShim.signal;
+
+signalCallback(signal);
+signalCallback(signalShim);
+
+signalShimCallback(signalShim);
+
+controllerCallback(controller);
+controllerCallback(controllerShim);
+
+controllerShimCallback(controllerShim);
+
+if (signalShim.aborted === false) {
+    signalShim.addEventListener("abort", abortCallback);
+    signalShim.removeEventListener("abort", abortCallback);
+    signalShim.onabort = null;
+    signalShim.onabort = abortCallback;
+}
+controllerShim.abort();

tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "compilerOptions": {
+        "lib": ["es2015", "dom"],
+        "noEmit": true,
+        "strict": true
+    },
+    "files": [
+        "test/types.ts"
+    ],
+    "exclude": [
+        "node_modules"
+    ]
+}