npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@knighttower/js-url-helper

v1.0.4

Published

JsUrlHelper is a JavaScript class to get the most common use cases with the URL object.

Downloads

4

Readme

urlHelper JavaScript Module Documentation

Note:

For better maintenance, this library has been placed along with JsUtilities (https://github.com/knighttower/JsUtility) to create an easier entry point for many resources that will collaborate together --> only the docs will remain here for now.

Overview

The urlHelper module is a utility library for URL manipulation and navigation with the 'window' object.


Installation

npm i @knighttower/js-utility-functions
yarn add @knighttower/js-utility-functions
import UrlHelper from '@knighttower/js-utility-functions';

In the browser

It loads as a 'window' object --> window.urlHelper

<script src=" https://cdn.jsdelivr.net/npm/@knighttower/js-utility-functions@latest/dist/browser/UrlHelper.min.js"></script>

// ---> Also available as ESM, UMD, CJS, JS
// ESM 
<script src="https://esm.run/@knighttower/js-utility-functions@latest/index.mjs"></script>
// UMD
<script src="https://cdn.jsdelivr.net/npm/@knighttower/js-utility-functions@latest/dist/umd/UrlHelper.min.js"></script>
// CJS
<script src="https://cdn.jsdelivr.net/npm/@knighttower/js-utility-functions@latest/dist/cjs/UrlHelper.min.js"></script>

Constants (gets)

fullUrl

  • Type: string
  • Description: The full URL including the current page path.

siteUrl

  • Type: string
  • Description: The root URL without the page path.

template

  • Type: string
  • Description: The template URL for sites that use template folders.

protocol

  • Type: string
  • Description: The server protocol (http/https).

host

  • Type: string
  • Description: The name of the server.

path

  • Type: string
  • Description: The current path.

readUrl

  • Type: string
  • Description: A readable URL.

Methods

getPage()

  • Returns: string
  • Description: Returns the current page name (Last part of the URL).

getParams()

  • Returns: Object
  • Description: Returns the query object info from the current URL.

getQuery()

  • Returns: string
  • Description: Returns the query string from the current URL.

addToQuery(query: Object)

  • Parameters: query (Object) - The query object to add.
  • Returns: Object
  • Description: Adds parameters to the current query string of the URL.

getHash()

  • Returns: string
  • Description: Returns only the URL hash.

setHash(h: string)

  • Parameters: h (string) - The hash to set.
  • Description: Sets the URL hash.

deleteHash()

  • Description: Removes the URL hash.

goTo(url: string)

  • Parameters: url (string) - The URL to go to.
  • Returns: boolean
  • Description: Goes to a specific URL on the same page.

open(url: string, name: string, params: string)

  • Parameters:
    • url (string) - The URL to open.
    • name (string) - The name attribute for the new window.
    • params (string) - The window parameters.
  • Returns: Window
  • Description: Opens a URL in the browser.

onChange(callback: function)

  • Parameters: callback (function) - The callback function to execute.
  • Description: Executes a function if the current URL changes.

Private Methods

parseURLParams()

  • Returns: Object
  • Description: Parses and returns URL parameters.

Checkout more cool stuff at https://knighttower.io/