Merge pull request #24 from oncletom/fix-24

isValid() does the wrong job
thom4parisot · Jan 8, 2013 · c4e459a · c4e459a
2 parents c5518aa + 5b84a08
commit c4e459a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -28,6 +28,8 @@ var tld = require('tldjs');
 
 ### getDomain()
 
+Returns the fully qualified domain from a host string.
+
 ```javascript
 tld.getDomain('google.com'); // returns `google.com`
 tld.getDomain('fr.google.com'); // returns `google.com`
@@ -39,11 +41,14 @@ tld.getDomain('fr.t.co'); // returns `t.co`
 
 ### isValid()
 
+Checks if the host string is valid.
+It does not check if the *tld* exists.
+
 ```javascript
 tld.isValid('google.com'); // returns `true`
-tld.isValid('t.co'); // returns `true`
-tld.isValid('t.go'); // returns `false`
-
+tld.isValid('.google.com'); // returns `false`
+tld.isValid('my.fake.domain'); // returns `true`
+tld.isValid('localhost'); // returns `false`
 ```
 
 ## Updating TLDs List

diff --git a/lib/tld.js b/lib/tld.js
@@ -147,7 +147,10 @@ tld.prototype.getDomain = function getDomain(host) {
 };
 
 /**
- * Checking if a host is valid
+ * Checking if a host string is valid
+ * It's usually a preliminary check before trying to use getDomain or anything else
+ *
+ * Beware: it does not check if the TLD exists.
  *
  * @api
  * @todo handle localhost, local etc.