node-bitly - Bitly API for nodejs
This module provides calls to the Bitly API for Nodejs. This documentation is for v6.0.1
.
For more information on the API request and responses visit the Bitly API docs
node-bitly
is programmed with TypeScript
but is compiled to JavaScript and supports node 6, 8, 10
. When you import the client you get full type information. There maybe be some gaps in the information but this will be filled in, in future releases.
Currently node-bitly
only supports Bitly's v3
API and has this hard coded in the parameter type. Support for version 4 will be added in a future release
Installation
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
Usage
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 offline, or you can view the index here (the generated documentation does not work on Github).
Code
TypeScript / ES6 Imports
import { BitlyClient } from 'bitly';
const bitly = new BitlyClient('<accessToken>', {});
async function init() {
let result;
try {
result = await bitly.shorten('https://github.com/tanepiper/node-bitly');
} catch (e) {
throw e;
}
return result;
}
init();
JavaScript
const { BitlyClient } = require('bitly');
const bitly = new BitlyClient('<accessToken>', {});
let result;
try {
result = await bitly.shorten(uri);
} catch(e) {
throw e;
}
return result;
If you are not using node 8
then you can still use the library with Promise
values:
const BitlyClient = require('bitly');
const bitly = new BitlyClient('<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 = new BitlyClient('<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;
}
Tests
To run tests type npm test
. Please note one test will fail if you use your own API key, please update the string accordingly.
Support on Beerpay
Hey dude! Help me out for a couple of :beers:!