Expose getPublicSuffix()

gavinuhma · Oct 31, 2011 · 2f1e409 · 2f1e409
1 parent 2a6b33c
commit 2f1e409
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -82,6 +82,15 @@ fromJSON(string)
 
 alias for `Cookie.fromJSON(string)`
 
+getPublicSuffix(hostname)
+-------------------------
+
+Returns the public suffix of this hostname.  The public suffix is the shortest domain-name upon which a cookie can be set.  Returns `null` if the hostname cannot have cookies set for it.
+
+For example: `www.example.com` and `www.subdomain.example.com` both have public suffix `example.com`.
+
+For further information, see http://publicsuffix.org/.  This module derives its list from that site.
+
 Cookie
 ======
 

diff --git a/lib/cookie.js b/lib/cookie.js
@@ -794,4 +794,5 @@ module.exports = {
   domainMatch: domainMatch,
   defaultPath: defaultPath,
   pathMatch: pathMatch,
+  getPublicSuffix: pubsuffix.getPublicSuffix,
 };