Skip to content

Latest commit

 

History

History
98 lines (66 loc) · 2.1 KB

README.md

File metadata and controls

98 lines (66 loc) · 2.1 KB

NPM version CI Downloads

Minify Url

Library to make url shorter

INSTALLAION

npm i url-minify
yarn add url-minify

USAGE

Currently 12 providers are supported

For typescript

import minify from 'url-minify';

~(async function () {
	console.log(
		await minify('https://rubiin.vercel.app', { provider: 'isgd' }),
	);

	// ==> {longUrl: 'https://rubiin.vercel.app',shortUrl: 'https://is.gd/PTkruq'}
})();

For plain js

const minify = require('url-minify').default;

~(async function () {
	console.log(
		await minify('https://rubiin.vercel.app', { provider: 'isgd' }),
	);

	// ==> {longUrl: 'https://rubiin.vercel.app',shortUrl: 'https://is.gd/PTkruq'}
})();

API

minify(link,options)

options

Type: object

provider

Type: string

Service to use for shortening links. Defaults to isgd Available providers: ''isgd' | 'cdpt' | 'vgd' | '4hnet' | 'tinube' | 'rbgy' | 'vurl' | 'haha' | 'pwm' | 'cya' | 'hideuri

timeout

Type: number

Response timeout in milliseconds. Defaults to 2000

Providers supported

Url shortner supports the following providers.

Provider Status
is.gd ✔️
cdpt.in ✔️
tinu.be ✔️
v.gd ✔️
rb.gy ✔️
4h.net ✔️
vurl.com ✔️
pwn.se ✔️
haha.se ✔️
cya.se ✔️
hideuri.com ✔️
tny.im ✔️

Contributing

Any types of contributions are welcome. Feel free to send pull requests or create issues.

License

Licensed under The MIT License.