urlgrey

What is urlgrey?

The urlgrey npm package is a utility for parsing, manipulating, and formatting URLs. It provides a fluent API for working with URLs, making it easy to construct, deconstruct, and modify URL components.

What are urlgrey's main functionalities?

Parsing URLs

This feature allows you to parse a URL string into an object that you can manipulate. The `urlgrey` function takes a URL string and returns an object representing the URL.

const urlgrey = require('urlgrey');
const url = urlgrey('http://example.com/path?query=1#hash');
console.log(url.toString());

Modifying URL Components

This feature allows you to modify different components of the URL such as the path, query string, and hash. The methods `path`, `query`, and `hash` are used to set new values for these components.

const urlgrey = require('urlgrey');
const url = urlgrey('http://example.com/path?query=1#hash');
const newUrl = url.path('/newpath').query('newquery=2').hash('newhash');
console.log(newUrl.toString());

Building URLs

This feature allows you to build a URL from scratch by setting various components like protocol, host, path, query, and hash. The fluent API makes it easy to chain these methods together.

const urlgrey = require('urlgrey');
const url = urlgrey().protocol('https').host('example.com').path('/newpath').query('newquery=2').hash('newhash');
console.log(url.toString());

Other packages similar to urlgrey

url

The 'url' package is a core Node.js module for URL resolution and parsing. It provides basic utilities for URL parsing and formatting but lacks the fluent API provided by urlgrey.

url-parse

The 'url-parse' package is a more feature-rich alternative to the core 'url' module. It provides similar functionality to urlgrey, including parsing and manipulating URLs, but with a different API design.

query-string

The 'query-string' package focuses on parsing and stringifying URL query strings. While it doesn't handle the entire URL, it can be used in conjunction with other packages to manage query parameters effectively.

README

urlgrey

Urlgrey is a library for url manipulation. It's got a fluent interface like jquery for reading and setting parts of a url.

See the tests for examples until I write some docs.