Code Monkey home page Code Monkey logo

url-parser-utils's Introduction

Url Parser Utils V1.0.0

URL parser for javascript. With this package, you will be able to get all the information about the URL in the browser. This information is presented to you in a disaggregated form. You will not need to put forth any extra effort. 💪💪

The returned url instance contains the following properties:
  • getProtocol: The protocol scheme of the URL (e.g. http || https).
  • getAuth: Authentication information portion (e.g. {username: string, password: string}).
  • getUsername: Username of basic authentication.
  • getPassword: Password of basic authentication.
  • getHost: Host name with port number. The hostname might be invalid.(e.g. localhost:8080)
  • getHostname: Host name without port number. This might be an invalid hostname. (e.g localhost)
  • getPort: Optional port number. (e.g 3000)
  • getPathname: URL path. (e.g /products)
  • getParams: URL params. (e.g. ["/param1", "/param2"] || ["/"] => default)
  • getQueries: Parsed object containing query string, unless parsing is set to false. (e.g {page: 1, limit: 10, q: "search value"})
  • getHashes: The "fragment" portion of the URL including the pound-sign (e.g.["hash1"]).
  • getHref: The full URL. (e.g. http://localhost:8080/ankara?query1=1&test=2#test)
  • getSubdomain: Get subdomain. (e.g. beta)
Usage (CSR or SSR project)
import UrlParser from  "url-parser-js";

const urlParser = new UrlParser();
    console.group({
      getProtocol: urlParser.getProtocol(),
      getHost: urlParser.getHost(),
      getHostname: urlParser.getHostname(),
      getPort: urlParser.getPort(),
      getPathname: urlParser.getPathname(),
      getQueries: urlParser.getQueries(),
      getHashes: urlParser.getHashes(),
      getSubdomain: urlParser.getSubdomain(),
      getHref: urlParser.getHref(),
      getPassword: urlParser.getPassword(),
      getUsername: urlParser.getUsername(),
      getAuth: urlParser.getAuth(),
      getParams: urlParser.getParams(),
    });
  },
Example code structure

with defensive code

public getQueries(): string[] {
    const isHaveQuery = this.url.search;
    let queries: string[] = [];
    if (isHaveQuery) {
      queries = this.url.search.split("?")[1]?.split("&");
    }
    return queries;
  }

Powered by Ahmet İlhan

url-parser-utils's People

Contributors

ahmetilhn avatar

Stargazers

 avatar

Watchers

 avatar

url-parser-utils's Issues

feature: `getParams` and `getQueries` function must be generic

request:
Returning some parameters or optional queries as objects will make it easier to manage. Therefore, these functions should be made generic and return an object.

For example we should be able to write code like below:

with generic function

import UrlParser from  "url-parser-js";

type PageParams = {
    id: string;
    slug: string;
}

const urlParser = new UrlParser();
const { id, slug } = urlParser.getParams<PageParams>();

or with generic class

import UrlParser from  "url-parser-js";

type PageParams = {
    id: string;
    slug: string;
}

const urlParser = new UrlParser<PageParams>();
const { id, slug } = urlParser.getParams();

// UrlParams: <Params = {}, Queries = {}>

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.