added: types

Author: GianlucaGuarini

index.d.ts

@@ -0,0 +1,12 @@
+type Scope = Element
+    | Window
+    | Document
+
+// borrowed from DOM querySelectorAll
+declare function $<K extends keyof HTMLElementTagNameMap>(selectors: K, scope?: Scope): NodeListOf<HTMLElementTagNameMap[K]>;
+declare function $<K extends keyof SVGElementTagNameMap>(selectors: K, scope?: Scope): NodeListOf<SVGElementTagNameMap[K]>;
+declare function $<E extends Element = Element>(selectors: string, scope?: Scope): NodeListOf<E>;
+declare function $<W extends Window>(selectors: W, scope?: Scope): [W];
+declare function $<D extends Document>(selectors: D, scope?: Scope): [D];
+
+export default $

index.next.js

@@ -3,12 +3,12 @@ import domToArray from 'bianco.dom-to-array'
 /**
  * Simple helper to find DOM nodes returning them as array like loopable object
  * @param   { string|DOMNodeList } selector - either the query or the DOM nodes to arraify
- * @param   { HTMLElement }        ctx      - context defining where the query will search for the DOM nodes
+ * @param   { HTMLElement }        scope      - context defining where the query will search for the DOM nodes
  * @returns { Array } DOM nodes found as array
  */
-export default function $(selector, ctx) {
+export default function $(selector, scope) {
   return domToArray(typeof selector === 'string' ?
-    (ctx || document).querySelectorAll(selector) :
+    (scope || document).querySelectorAll(selector) :
     selector
   )
 }

package-lock.json

@@ -5,6 +5,7 @@
   "main": "index.js",
   "jsnext:main": "index.next.js",
   "module": "index.next.js",
+  "types": "index.d.ts",
   "scripts": {
     "prepare": "npm run build && npm test",
     "lint": "eslint index.next.js test.js rollup.config.js",