Open URL JS 🔍

Simply manage urls.

Install

npm install open-url-js

Usage

var Url = require('open-url-js');
 
var url = new Url('https://www.myapp.com:3000/users/:id/#profile?user[lang]=fr');
url;
// => Url {
//      protocol: 'https',
//      host: 'www.myapp.com',
//      port: 3000,
//      path: Pathname ['users', ':id', root: true],
//      hash: 'profile',
//      parameters: Parameters {
//        user: Parameters {
//          lang: fr
//        }
//      }
//    }
 
url.path.id = 4;
url.string;
// => 'https://www.myapp.com:3000/users/4/#profile?user[lang]=fr';
 
url.parameters = {
  lang: 'en',
  zone: 'United States'
};
url.string;
// => 'https://www.myapp.com:3000/users/4/#profile?lang=fr&zone=United%20States';

Url

Kind: global class

• Url
  • new Url(...string)
  • .string : string
  • .protocol : string
  • .host : string
  • .port : string
  • .hash : string
  • .path : Pathname
  • .parameters : Parameters
  • .clear() ⇒ Url
  • .toString() ⇒ string

new Url(...string)

Create a Url object.

Param	Type	Description
...string	Object	Same value as string.

url.string : string

A string corresponding to the url. When set, it will be parsed.

Kind: instance property of Url

url.protocol : string

The protocol of the url.

Kind: instance property of Url

url.host : string

The host of the url.

Kind: instance property of Url

url.port : string

The port of the url.

Kind: instance property of Url

url.hash : string

The hash of the url.

Kind: instance property of Url

url.path : Pathname

The path of the url.

Kind: instance property of Url

url.parameters : Parameters

The parameters of the url.

Kind: instance property of Url

url.clear() ⇒ Url

Clears the url.

Kind: instance method of Url
Returns: Url - Itself.

url.toString() ⇒ string

Kind: instance method of Url
Returns: string - Value of string.