Merge pull request #2 from jdesrosiers/types

Add types

Author: SorinGFS

index.d.ts

@@ -0,0 +1,32 @@
+import punycode = require('punycode/');
+
+/**
+ * Validate a hostname. Returns true or throws a detailed error.
+ *
+ * @throws {SyntaxError}
+ */
+declare function isIdnHostname(hostname: string): true;
+
+/**
+ * Returns the ACE hostname or throws a detailed error (it also validates the input)
+ *
+ * @throws {SyntaxError}
+ */
+declare function idnHostname(hostname: string): string;
+
+/**
+ * Returns the uts46 mapped label (not hostname) or throws an error if the label
+ * has dissallowed or unassigned chars.
+ *
+ * @throws {SyntaxError}
+ */
+declare function uts46map(label: string): string;
+
+declare const IdnHostname: {
+  isIdnHostname: typeof isIdnHostname;
+  idnHostname: typeof idnHostname;
+  uts46map: typeof uts46map;
+  punycode: typeof punycode;
+};
+
+export = IdnHostname;

package.json

@@ -26,5 +26,8 @@
   },
   "dependencies": {
     "punycode": "^2.3.1"
+  },
+  "devDependencies": {
+    "@types/punycode": "^2.1.4"
   }
 }