Giter Club home page Giter Club logo

clean-urls's Introduction

@inframanufaktur/clean-urls

Utility to remove tracking parameters from an URL

Usage

Basic usage:

const removeParams = require("@inframanufaktur/clean-urls");

const cleaned = removeParams("https://www.test.com/?utm_source=test");
// --> 'https://www.test.com/'

Allow companies through an allowlist:

const removeParams = require("@inframanufaktur/clean-urls");

const cleaned = removeParams(
  "https://www.test.com/?utm_source=test&pk_campaign=test",
  ["Piwik"]
);
// --> 'https://www.test.com/?pk_campaign=test'

How it works

The package takes the string of an URL and converts it with new URL.

Since it uses new URL you can only use this with URLs that contain a protocol and a hostname. /about/?utm_source=test will not work.

The search parameters of the URLs are matched against the list in ./data/params.js. It it matches and the associated company is not present in your allowlist, the param gets removed.

Compatability

Needs Node >v10 as its uses new URL().

clean-urls's People

Contributors

ovlb avatar

Stargazers

Johan Eliasson avatar Lim Leong Kui avatar Nathan Hutchision avatar Dane Wilson avatar David Wells avatar Bret Comnes avatar

Watchers

 avatar

Forkers

rounakdatta

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.