stu01509 / pretty-link

🔗 A powerful Node.js short URL library, currently supporting Bitly, TinyURL, PicSee, reurl, 0rz.tw

🔗Pretty-Link : A powerful Node.js short URL library

Installation

In order to use Pretty-Link, make sure that you have Node version 8.0.0 or higher.

npm install prettylink

Or Yarn.

yarn add prettylink

Usage

Pretty-Link this module provides five URL shorten service, such as Bitly, TinyURL, PicSee, reurl and Pixnet0rz.tw, to calls to their API for Node.js

For more information on the Token applicant or API request and responses please checkout API Info or visit their official guide.

const prettylink = require('prettylink');

// Init Access Token in constructor 
const bitly = new prettylink.Bitly('BitlyAccessToken');
// Or use init function
bitly.init('BitlyAccessToken');
bitly.short('https://github.com/stu01509/pretty-link').then((result) => {
  console.log(result);
}).catch((err) => {
  console.log(err);
});

See examples folder for more detail examples.

API Info

Bitly

Bitly Official API docs Bitly Access Token generate

• bitly.init(AccessToken) - Initialize AccessToken.
• bitly.short(longUrl) - Convert a long url to short url.
• bitly.expand(bitlinkId) - Convert a bitlink short url to original link.
• bitly.getCountries(bitlink, unit, units, size) - Get metrics about the countries referring click traffic to a single Bitlink.
• bitly.getReferrers(bitlink, unit, units, size) - Get metrics about the referrers referring click traffic to a single Bitlink.
• bitly.getReferrersDomains(bitlink, unit, units, size) - Get metrics about rollup the click counts to a referrer about a single Bitlink.
• bitly.getClickSummary(bitlink, unit, units, size) - Get click counts for a specified Bitlink, This rolls up all the data
• bitly.getClick(bitlink, unit, units, size) - Get click counts for a specified Bitlink, This returns an array with clicks based on a date.
• bitly.getLinkInfo(bitlink) - Get information for a Bitlink.

📌 Pretty-Link only supports Bitly's v4 API, not Compatible v3 API

TinyURL

• tinyUrl.short(longUrl) - Convert a long url to short url.

PicSee

PicSee Official API docs

• picsee.init(AccessToken) - Initialize AccessToken.
• picsee.short(longUrl) - Convert a long url to short url.
• picsee.customShortUrlMeta(longUrl, title, description, imageUrl) - Custom short url meta info.
• picsee.getOverview(linkId) - Get short url overview info, PicSee link id, like this 'KK6X6'.

reurl

reurl Official API docs

• reurl.init(AccessToken) - Initialize AccessToken.
• reurl.short(longUrl) - Convert a long url to short url.

Cutt.ly

Cutt.ly Official API docs

• cuttly.init(AccessToken) - Initialize AccessToken.
• cuttly.short(longUrl) - Convert a long url to short url.

Pixnet0rz.tw

• pixnet0rz.short(longUrl) - Convert a long url to short url.

Demo

Test

⚠️ To run Mocha tests type npm test. Please note the test will fail if you don't replace your own API key or Access Token.

Contributing

🎉 Welcome to Directly send PRs!

License

MIT

pretty-link's Issues

Cuttly not added to yarn

You can't access Cuttly from the loaded package