Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.06 KB

README.md

File metadata and controls

50 lines (33 loc) · 1.06 KB

URL Masker

A package for adding an extra URL to provided with your own prefix using MongoDB.

Installation

You can install the package via npm:

npm install url-masker

Usage

First, import the MaskUrl class from the package:

import MaskUrl from "url-masker";

Then, create an instance of MaskUrl by providing the MongoDB connection string and the prefix URL:

const urlMasker = new MaskUrl("mongodb+srv://<username>:<password>@<cluster-address>/<database>","https://example.com");

Next, connect to the MongoDB database:

urlMasker.connectToDatabase()
  .then(() => {
    console.log(urlMasker.urlMasker(<URL_TO_MASK>));
}).catch((error) => {
    console.error("Error connecting to the database:", error);
});

Once you have your new URL, you can simple use the new URL to fetch the Old url.

urlMasker.fetchUrl(<Masked_URL>);

TO-DO

To make this fully work you will have to deploy this on a server with your domain which will redirect to the url.

License

This project is licensed under the MIT License