Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

links-shortener

1.0.7 • Public • Published

links-shortener

Java Script library for shortening links depending on the search phrase.

github issue dependencies Status license npm version npm bundle size

Features

  • Very easy to understand
  • Configurable max length of link
  • Only one dependency

Installation

  • download from GitHub
  • npm: npm install links-shortener

makeURLShorter

makeURLShorter - main function for shortening link. Parameters:

  • link
  • searchValue
  • maxLength

See examples below

Examples

The examples below showing how the link is shortening depending on where the search phrase (searchValue) is.

Search phrase in url domain

var linkShortener = require('links-shortener');
 
var link = "http://www.subdomain.domain.com/directory2018/home/test/cat3?param1&param2&param3#lastpartofverylongurl";
var maxLength = 40;      // max lenght of link
var searchValue = 'com';
 
var shortenedLink = linkShortener.makeURLShorter(link, searchValue, maxLength);
console.log(shortenedLink);
 
//prints 'www.subdomain.domain.com/directory2018/home/test/cat3?param1&param2&param3#lastpartofverylongurl'

Search phrase in url path

var searchValue = 'test';
 
var shortenedLink = linkShortener.makeURLShorter(link, searchValue, maxLength);
console.log(shortenedLink);
 
// prints '...domain.domain.com/...home/test/cat3?param1&param2&param3#lastpartofverylongurl'    

Search phrase in url query

var searchValue = 'param2';
 
var shortenedLink = linkShortener.makeURLShorter(link, searchValue, maxLength);
console.log(shortenedLink);
 
// prints '...domain.com/directory...?...ram1&param2&param#lastpartofverylongurl'

Search phrase(searchValue) in url fragment

var searchValue = 'part';
 
var shortenedLink = linkShortener.makeURLShorter(link, searchValue, maxLength);
console.log(shortenedLink);
 
//prints '...ain.com/direct...?param1...#lastpartofverylongurl'

install

npm i links-shortener

Downloadsweekly downloads

15

version

1.0.7

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability