This module provides calls to the Bitly API for Nodejs. For more information on the API request and responses visit the Bitly API docs
node-bitly
is programmed with ES7 async/await
but uses the typescript
compiler to ES5, so the library has
been tested back to support node v4.8.4
To install via NPM type the following: npm install bitly
You can also install via git by cloning: git clone https://github.com/tanepiper/node-bitly.git /path/to/bitly
This library uses the API provided by bitly and requires an OAuth token to use. To get your access token, visit OAuth Apps (under Generic Access Token)
See http://dev.bitly.com for format of returned objects from the API
To see the available libary APIs, you can view the API Documentation
const BitlyClient = require('bitly');
const bitly = BitleyClient('<accessToken>');
try {
return await bitly.shorten(uri);
} catch(e) {
throw e;
}
If you are not using node 8
then you can still use the library with Promise
values:
const BitlyClient = require('bitly');
const bitly = BitleyClient('<accessToken>');
bitly.shorten('https://github.com/tanepiper/node-bitly')
.then(function(result) {
console.log(result);
})
.catch(function(error) {
console.error(error);
});
You can also do raw requests to any Bitly endpoint. With this you need to pass the access token to the method
const BitlyClient = require('bitly');
const bitly = BitleyClient('<accessToken>');
try {
return await bitly.bitlyRequest('link/referrers_by_domain', {
link: 'https://github.com/tanepiper/node-bitly,
unit: 'hour',
timezone: 'Europe/Amsterdam'
});
} catch(e) {
throw e;
}
To run tests type npm test
.