Skip to content

📦 An easy cross-platform utility library to work with URLs in Javascript.

Notifications You must be signed in to change notification settings

adenekan41/urley

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


urley

A cross-platform library with a collection of handy utilites to work with URLs



npm

NPM


🔍 Try out the interactive Demo on codesandbox

⚡️About

Urley, A cross-platform utility library to work with URLs. Urely has a collection of handy helpers to use when working with URLs, with just a few imports you are set.

✨ Features

  • 📦 Light Weight ~885b (gzipped)
  • 🔧 Cross platform supported
  • 🙅‍♂️ Zero dependencies
  • ✅ Fully tested and reliable
  • ⚒ CommonJS, ESM & browser standalone support

⬇ Installing urley

Using NPM

npm i urley

Using Yarn

yarn add urley

🛠 Usage

Getting familiar with the libary and you want to use some helper functions like getBaseUrl, getPathnameToObject, isAbsoluteUrl helpers e.t.c you can easily just import them the following ways.

import { isAbsolute } from 'urley';

All methods are exported as a flat namesapce so you can also call them like this

import isAbsolute from 'urley/bundle-es/isAbsolute';

or

var isAbsolute = require('urley');

and then we have the exported helpers and can already do this

isAbsolute('https://google.com');
// => true

📁 Documentation View Here

Is Absolute

returns - Boolean

Is Browser

returns - Boolean

  • isBrowser - Determines if the current runtime environment is a browser. see file here

Is Valid URL

returns - Boolean

  • isValidUrl - Returns Boolean if the given string/URL is valid. see file here

Get Base URL

parameters - url (String)

returns - String

  • getBaseUrl - Returns the current URL without any parameters. see file here

Decode URL

parameters - str (String)

returns - String

  • decodeUrl - Function decodes a Uniform Resource Identifier (URI) component previously created by decodeURIComponent or by a similar routine. see file here

Encode URL

parameters - str (String)

returns - String

  • encodeUrl - Function encodes a Uniform Resource Identifier (URI) component previously created by encodeURIComponent or by a similar routine. see file here

Get URL Parameters

parameters - url (String)

returns - Object

  • getUrlParameters - Returns an object containing the parameters of the current URL. see file here

Get Path Name

parameters - url (String)

returns - String

  • getPathname - Returns pathname with a regex exec function see file here

Path Name To Object

parameters - url (String)

returns - Object

  • pathnameToObject - Returns pathname into an object see file here

Join URL

parameters - urls (String)

returns - String

  • joinUrl - Join all given URL segments together, then normalizes the resulting URL see file here

Window Portion

parameters - url (String)

returns - string

  • getWindowPathname - Return pathname if parameter is passed or uses the one in the current window environment. see file here

  • getWindowHost - Return host if parameter is passed or uses the one in the current window environment. see file here

  • getWindowHostName - Return hostname if parameter is passed or uses the one in the current window environment. see file here

  • getWindowHash - Return hash if parameter is passed or uses the one in the current window environment. see file here

  • getWindowHref - Return href if parameter is passed or uses the one in the current window environment. see file here

  • getWindowPort - Return port if parameter is passed or uses the one in the current window environment. see file here

  • getWindowProtocol - Return protocol if parameter is passed or uses the one in the current window environment. see file here

  • getWindowSearch - Return search if parameter is passed or uses the one in the current window environment. see file here

MIT © codewonders.dev  ·  GitHub @adenekan41 >  · 

About

📦 An easy cross-platform utility library to work with URLs in Javascript.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages