Socket
Socket
Sign inDemoInstall

parse-path

Package Overview
Dependencies
2
Maintainers
2
Versions
18
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

parse-path


Version published
Maintainers
2
Created

Package description

What is parse-path?

The parse-path npm package is a utility for parsing URLs and file paths into their constituent parts. It can handle a variety of path formats and provides a structured way to access different components of a path.

What are parse-path's main functionalities?

Parse URL

This feature allows you to parse a URL into its components such as protocol, host, port, pathname, query, and hash.

const parsePath = require('parse-path');
const parsedUrl = parsePath('https://example.com:8080/path/name?query=string#hash');
console.log(parsedUrl);

Parse File Path

This feature allows you to parse a file path into its components such as root, dir, base, ext, and name.

const parsePath = require('parse-path');
const parsedFilePath = parsePath('/home/user/docs/file.txt');
console.log(parsedFilePath);

Handle Different Path Formats

This feature allows you to handle different path formats, including Windows-style paths, and parse them into their components.

const parsePath = require('parse-path');
const parsedPath = parsePath('C:\Users\user\docs\file.txt');
console.log(parsedPath);

Other packages similar to parse-path

Readme

Source

parse-path

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

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

:cloud: Installation

# Using npm
npm install --save parse-path

# Using yarn
yarn add parse-path

:clipboard: 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' }

:question: 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. :bug:

  3. For direct and quick help, you can use Codementor. :rocket:

:memo: 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.

:yum: How to contribute

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

:sparkling_heart: 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 :rocket:

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

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. :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! :heart:

:dizzy: Where is this library used?

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

  • parse-url—An advanced url parser supporting git urls too.

:scroll: License

MIT © Ionică Bizău

Keywords

FAQs

Last updated on 28 Oct 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc