Nukem's Possible Manifestation
    Have ideas to improve npm?Join in the discussion! »

    parse-path
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/parse-path package

    4.0.3 • Public • Published

    parse-path

    Support me on Patreon Buy me a book PayPal Ask me anything Travis Version Downloads Get help on Codementor

    Buy Me A Coffee

    Parse paths (local paths, urls: ssh/git/etc)

    ☁️ Installation

    # Using npm
    npm install --save parse-path
    
    # Using yarn
    yarn add parse-path

    📋 Example

    // Dependencies
    const parsePath = require("parse-path")
    
    console.log(parsePath("http://ionicabizau.net/blog"))
    // { protocols: [ 'http' ],
    //   protocol: 'http',
    //   port: null,
    //   resource: 'ionicabizau.net',
    //   user: '',
    //   pathname: '/blog',
    //   hash: '',
    //   search: '',
    //   href: 'http://ionicabizau.net/blog' }
    
    console.log(parsePath("http://domain.com/path/name?foo=bar&bar=42#some-hash"))
    // { protocols: [ 'http' ],
    //   protocol: 'http',
    //   port: null,
    //   resource: 'domain.com',
    //   user: '',
    //   pathname: '/path/name',
    //   hash: 'some-hash',
    //   search: 'foo=bar&bar=42',
    //   href: 'http://domain.com/path/name?foo=bar&bar=42#some-hash' }
    
    console.log(parsePath("git+ssh://git@host.xz/path/name.git"))
    // { protocols: [ 'git', 'ssh' ],
    //   protocol: 'git',
    //   port: null,
    //   resource: 'host.xz',
    //   user: 'git',
    //   pathname: '/path/name.git',
    //   hash: '',
    //   search: '',
    //   href: 'git+ssh://git@host.xz/path/name.git' }
    
    console.log(parsePath("git@github.com:IonicaBizau/git-stats.git"))
    // { protocols: [],
    //   protocol: 'ssh',
    //   port: null,
    //   resource: 'github.com',
    //   user: 'git',
    //   pathname: '/IonicaBizau/git-stats.git',
    //   hash: '',
    //   search: '',
    //   href: 'git@github.com:IonicaBizau/git-stats.git' }

    Get Help

    There are few ways to get help:

    1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
    2. For bug reports and feature requests, open issues. 🐛
    3. For direct and quick help, you can use Codementor. 🚀

    📝 Documentation

    parsePath(url)

    Parses the input url.

    Params

    • String url: The input url.

    Return

    • Object An object containing the following fields:
    • protocols (Array): An array with the url protocols (usually it has one element).
    • protocol (String): The first protocol, "ssh" (if the url is a ssh url) or "file".
    • 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.
    • query (Object): The url querystring, parsed as object.

    😋 How to contribute

    Have an idea? Found a bug? See how to contribute.

    💖 Support my projects

    I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

    However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

    • Starring and sharing the projects you like 🚀

    • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

    • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

    • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

    • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

    Thanks! ❤️

    💫 Where is this library used?

    If you are using this library in one of your projects, add it in this list.

    • parse-url
    • @semantic-release/gitlab
    • @hawkingnetwork/react-native-tab-view
    • eleventy-plugin-embed-soundcloud
    • eleventy-plugin-embed-twitter
    • tria-prima
    • react-fsm-router
    • @tjoussen/semantic-release-gitlab-mr
    • @devdiary/semantic-devdiary-release
    • semantic-release-gitlab-plugin
    • reddit-title-has-verbatim-quote
    • @apardellass/react-native-audio-stream
    • l2forlerna
    • react-native-plugpag-wrapper
    • @alphy11/semantic-release-gitlab
    • react-native-pulsator-native
    • react-native-kakao-maps
    • @geeky-apo/react-native-advanced-clipboard
    • native-apple-login
    • native-google-login
    • native-kakao-login
    • @hemith/react-native-tnk
    • react-native-contact-list
    • @corelmax/react-native-my2c2p-sdk
    • @cloudoki/donderflow
    • electron-info
    • @tru_id/tru-sdk-react-native
    • @datalogic/react-native-datalogic-module
    • react-native-responsive-size
    • react-native-flyy
    • react-native-esc-pos-sahaab

    📜 License

    MIT © Ionică Bizău

    Install

    npm i parse-path

    DownloadsWeekly Downloads

    2,566,098

    Version

    4.0.3

    License

    MIT

    Unpacked Size

    12.7 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar
    • avatar