Skip to content

A simple URL shortener module, using multiple services to shorten URLs

License

Notifications You must be signed in to change notification settings

johan-perso/moreshort

Repository files navigation

Version française ici.

MoreShort

A library capable of shortening links through a simple function, using multiple services with short domain names.

Supported domains/services

mdrr.fr ptdrr.com
is.gd v.gd
s.oriondev.fr liba.ro
s.3vm.cl s.erc.hr
s.585.eu s.jib.ar
s.ahpc.fi s.acme.si
s.cije.us s.coute.au
s.fronturi.ro shor.vercel.app

Installation

NodeJS

No support is guaranteed for old versions of NodeJS.

# With npm
npm i moreshort

# Or with pnpm
pnpm i moreshort
const moreshort = require('moreshort')

console.log(moreshort) // Returns information about the library
console.log(await moreshort.short('https://google.com')) // Returns a shortened link

Browser

<script src="https://cdn.jsdelivr.net/npm/moreshort/dist/browser.js"></script>
console.log(moreshort) // Returns information about the library
console.log(await moreshort.short('https://google.com')) // Returns a shortened link

In the browser, you can use the short function directly, without needing to use moreshort.short.

Using the main method

The main function has 3 arguments:

  • url : The URL to shorten (string)
  • provider : Domain name of the service to use (string)
  • You can get the list of available services with moreshort.servicesDomains

  • shortcode : Short code to use (string)
  • Will be present in the shortened URL, after the slash (e.g. https://is.gd/shortcode)

  • Only some services support this feature; moreshort.servicesInfos has a boolean property shortcode for each service

Example :

const moreshort = require('moreshort')

console.log(await moreshort.short('https://google.com')) // Shortened with a random service
console.log(await moreshort.short('https://google.com', 'is.gd')) // Shortened with the is.gd service
console.log(await moreshort.short('https://google.com', 'is.gd', 'google')) // Shortened with the is.gd service and the short code "google"

License

MIT © Johan