Giant blob of minor changes
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / uri-js / README.md
index 3f225e74508deb151f2c03c031a0ba4830c1470b..3dbe4054f2577a9763b1222939a235ac947e98e0 100644 (file)
@@ -3,7 +3,7 @@
 URI.js is an [RFC 3986](http://www.ietf.org/rfc/rfc3986.txt) compliant, scheme extendable URI parsing/validating/resolving library for all JavaScript environments (browsers, Node.js, etc).
 It is also compliant with the IRI ([RFC 3987](http://www.ietf.org/rfc/rfc3987.txt)), IDNA ([RFC 5890](http://www.ietf.org/rfc/rfc5890.txt)), IPv6 Address ([RFC 5952](http://www.ietf.org/rfc/rfc5952.txt)), IPv6 Zone Identifier ([RFC 6874](http://www.ietf.org/rfc/rfc6874.txt)) specifications.
 
-URI.js has an extensive test suite, and works in all (Node.js, web) environments. It weighs in at 6.2kb (gzipped, 16kb deflated).
+URI.js has an extensive test suite, and works in all (Node.js, web) environments. It weighs in at 6.4kb (gzipped, 17kb deflated).
 
 ## API
 
@@ -101,9 +101,23 @@ URI.js supports inserting custom [scheme](http://en.wikipedia.org/wiki/URI_schem
 *      urn \[[RFC 2141](http://www.ietf.org/rfc/rfc2141.txt)\]
 *      urn:uuid \[[RFC 4122](http://www.ietf.org/rfc/rfc4122.txt)\]
 
-### HTTP Support
+### HTTP/HTTPS Support
 
        URI.equal("HTTP://ABC.COM:80", "http://abc.com/") === true
+       URI.equal("https://abc.com", "HTTPS://ABC.COM:443/") === true
+
+### WS/WSS Support
+
+       URI.parse("wss://example.com/foo?bar=baz");
+       //returns:
+       //{
+       //      scheme : "wss",
+       //      host: "example.com",
+       //      resourceName: "/foo?bar=baz",
+       //      secure: true,
+       //}
+
+       URI.equal("WS://ABC.COM:80/chat#one", "ws://abc.com/chat") === true
 
 ### Mailto Support
 
@@ -152,9 +166,11 @@ To load in a browser, use the following tag:
 
        <script type="text/javascript" src="uri-js/dist/es5/uri.all.min.js"></script>
 
-To load in a CommonJS (Node.js) environment, first install with npm by running on the command line:
+To load in a CommonJS/Module environment, first install with npm/yarn by running on the command line:
 
        npm install uri-js
+       # OR
+       yarn add uri-js
 
 Then, in your code, load it using:
 
@@ -183,17 +199,3 @@ URI validation has been removed as it was slow, exposed a vulnerabilty, and was
 ### Breaking changes from 1.x
 
 The `errors` array on parsed components is now an `error` string.
-
-## License ([Simplified BSD](http://en.wikipedia.org/wiki/BSD_licenses#2-clause))
-
-Copyright 2011 Gary Court. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1.     Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-2.     Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY GARY COURT "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARY COURT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of Gary Court.