better docs, adding to namespace

canjs · May 11, 2018 · d5ecc77 · d5ecc77
1 parent 6b1f678
commit d5ecc77
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 19 deletions.
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/can-parse-uri-test.js b/can-parse-uri-test.js
@@ -4,15 +4,15 @@ var QUnit = require('steal-qunit');
 QUnit.module("can-parse-uri");
 
 QUnit.test("basics", function(){
-	QUnit.deepEqual(parseURI("http://foo:8080/bar.html#change"), {
-    authority: "//foo:8080",
-    hash: "#change",
-    host: "foo:8080",
-    hostname: "foo",
-    href: "http://foo:8080/bar.html#change",
-    pathname: "/bar.html",
-    port: "8080",
-    protocol: "http:",
-    search: ""
-  });
+	QUnit.deepEqual(parseURI("http://foo:8080/bar.html?query#change"), {
+		authority: "//foo:8080",
+		hash: "#change",
+		host: "foo:8080",
+		hostname: "foo",
+		href: "http://foo:8080/bar.html?query#change",
+		pathname: "/bar.html",
+		port: "8080",
+		protocol: "http:",
+		search: "?query"
+	});
 });
diff --git a/can-parse-uri.js b/can-parse-uri.js
@@ -6,12 +6,29 @@
  *
  * Parse a URI into its components.
  *
+ * ```js
+ * import {parseURI} from "can"
+ * parseURI("http://foo:8080/bar.html?query#change")
+ * //-> {
+ * //  authority: "//foo:8080",
+ * //  hash: "#change",
+ * //  host: "foo:8080",
+ * //  hostname: "foo",
+ * //  href: "http://foo:8080/bar.html?query#change",
+ * //  pathname: "/bar.html",
+ * //  port: "8080",
+ * //  protocol: "http:",
+ * //  search: "?query"
+ * // }
+ * ```
+ *
  * @param {String} url The URL you want to parse.
  *
- * @return {Object} Returns an object with properties for each part of the URL.
+ * @return {Object} Returns an object with properties for each part of the URL. `null`
+ * is returned if the url can not be parsed.
  */
-
-module.exports = function(url){
+var namespace = require("can-namespace");
+module.exports = namespace.parseURI = function(url){
 		var m = String(url).replace(/^\s+|\s+$/g, '').match(/^([^:\/?#]+:)?(\/\/(?:[^:@]*(?::[^:@]*)?@)?(([^:\/?#]*)(?::(\d*))?))?([^?#]*)(\?[^#]*)?(#[\s\S]*)?/);
 			// authority = '//' + user + ':' + pass '@' + hostname + ':' port
 		return (m ? {

diff --git a/package.json b/package.json
@@ -26,7 +26,7 @@
     "develop": "done-serve --static --develop --port 8080",
     "detect-cycle": "detect-cyclic-packages --ignore done-serve"
   },
-  "main": "dist/cjs/can-parse-uri",
+  "main": "can-parse-uri",
   "keywords": [
     "canjs",
     "parse",
@@ -44,12 +44,11 @@
       "steal-tools"
     ]
   },
-  "dependencies": {},
+  "dependencies": {
+    "can-namespace": "^1.0.0"
+  },
   "devDependencies": {
     "detect-cyclic-packages": "^1.1.0",
-    "done-serve": "^1.0.0",
-    "donejs-cli": "^1.0.0",
-    "generator-donejs": "^1.0.0",
     "jshint": "^2.9.1",
     "steal": "^1.3.1",
     "steal-qunit": "^1.0.1",