rinse-url v0.1.8

rinse-url

This is a javascript library to remove unnecessary parameters, such as user-tracking codes, from a URL. In other words, for a given URL, it returns the shortest URL that has the same content.

How to use

import { rinseURL, RinseOptions } from 'rinse-url';

const url = 'https://youtu.be/ElDPCKO1EhE?si=LrGi9WKADPEoF5nz';

// optional
const options: RinseOptions = {
  testInterval: 1000, // interval to check if the content is the same
  similarityThreshold: 0.9, // cosine similarity threshold
};

const rinsedURL = await rinseURL(url, options);
console.log(rinsedURL); // https://youtu.be/ElDPCKO1EhE

Options

• testInterval: Interval to check if the content is the same. Default is 300ms.
• similarityThreshold: Cosine similarity threshold. Default is 0.9.
• timeout: The timeout for each test in milliseconds. Default is 10000ms.

Algorithm

rinse-url finds URL parameters that doesn't affect the content of the page and removes them. It removes parameters one by one and checks if the content of the page changes.

It considers the two pages are the same by checking if the main content of the two pages are similar enough (cosine similarity).

How to publish

From the documentation:

1. Run nx release --skip-publish locally. This will create a commit with the version and changelog updates, then create a tag for the new version.
2. Push the changes (including the new tag) to the remote repository with git push && git push --tags.
3. The CI workflow will automatically trigger and publish the packages to the npm registry.

Contributing

If you find a case that rinse-url doesn't work as expected, please open an issue or a pull request.