Package Exports
- git-up
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (git-up) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
git-up
A low level git url parser.
☁️ Installation
$ npm i --save git-up📋 Example
// Dependencies
var gitUp = require("git-up");
console.log(gitUp("git@github.com:IonicaBizau/node-parse-url.git"));
// => {
// protocols: []
// , port: null
// , resource: "github.com"
// , user: "git"
// , pathname: "/IonicaBizau/node-parse-url.git"
// , hash: ""
// , search: ""
// , href: "git@github.com:IonicaBizau/node-parse-url.git"
// , protocol: "ssh"
// }
console.log(gitUp("https://github.com/IonicaBizau/node-parse-url.git"));
// => {
// protocols: [ "https" ]
// , port: null
// , resource: "github.com"
// , user: ""
// , pathname: "/IonicaBizau/node-parse-url.git"
// , hash: ""
// , search: ""
// , href: "https://github.com/IonicaBizau/node-parse-url.git"
// , protocol: "https"
// }📝 Documentation
gitUp(input)
Parses the input url.
Params
- String
input: The input url.
Return
- Object An object containing the following fields:
protocols(Array): An array with the url protocols (usually it has one element).port(null|Number): The domain port.resource(String): The url domain (including subdomains).user(String): The authentication user (usually for ssh urls).pathname(String): The url pathname.hash(String): The url hash.search(String): The url querystring value.href(String): The input url.protocol(String): The git url protocol.token(String): The oauth token (could appear in the https urls).
😋 How to contribute
Have an idea? Found a bug? See how to contribute.
💰 Donations
Another way to support the development of my open-source modules is to set up a recurring donation, via Patreon. 🚀
PayPal donations are appreciated too! Each dollar helps.
Thanks! ❤️
💫 Where is this library used?
If you are using this library in one of your projects, add it in this list. ✨
git-url-parse—A high level git url parser for common git providers.ship-release—Publish new versions on GitHub and npm with ease.