Repository files navigation

In March 2020, Bitly deprecated the v3 of their API, and switched to v4. Unfortunately, even with the changes to this package to make it compatible, there are several unavoidable breaking changes. These are summarized below:

• Endpoints no longer support bulk options (multiple hashes or URLs in a single request)
  • Most importantly, this affectsexpand() andshorten()
  • As a general rule of thumb,none of the v4 endpoints take bulk inputs
• Return types have changed, for multiple endpoints
• DEPRECATED: Thelookup method and corresponding endpoint have been deprecated

With these changes all previous versions of this library are now full deprecated and there is only 1 version starting with v7.0.0

Here is a simple example of how you might have to update your use of node-bitly to account for the change:

// Both versionsconstBitlyClient=require('bitly').BitlyClient;constbitly=newBitlyClient('<accessToken>');// v6.1.0asyncfunctionexample(url){constresponse=awaitbitly.shorten(url);console.log(`Your shortened bitlink is${response.url}`);}// v7.x.xasyncfunctionexample(url){constresponse=awaitbitly.shorten(url);console.log(`Your shortened bitlink is${response.link}`);}

This module provides calls to theBitly API forNodejs.

For more information on the API request and responses visit theBitly API docs

node-bitly is programmed withTypeScript but is compiled to JavaScript and supportsnode >= 10.0.0. 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.

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, visitOAuth Apps (under Generic Access Token)

Seehttp://dev.bitly.com for format of returned objects from the API

To see the available libary APIs, you can view theAPI Documentation offline, or you can view the index here (the generated documentation does not work on Github).

import{BitlyClient}from'bitly';constbitly=newBitlyClient('<accessToken>',{});asyncfunctioninit(){letresult;try{result=awaitbitly.shorten('https://github.com/tanepiper/node-bitly');}catch(e){throwe;}returnresult;}init();

When the library throws an error, it should be the error object response from Bitly, but if something has gone wrong with your internet or intermediate requests, it is possible that a generic AxiosError might get returned. You can use an exported Type Guard to narrow the type:

import{BitlyClient,isBitlyErrResponse}from'bitly';constbitly=newBitlyClient(process.env.BITLY_API_KEY);letdata:BitlyLink;try{data=awaitbitly.shorten('http://bit.ly/38XaXKy');}catch(error){if(isBitlyErrResponse(error)){// Inferred type by TS is `BitlyErrorResponse`console.log(`Bitly error:${error.description}`);}elseif(error.isAxiosError){// Infererred type is `any`, but you can cast to AxiosError safelyconstaxiosError=errorasunknownasAxiosError;console.log(`AxiosError:`,axiosError.toJSON());}}

const{ BitlyClient}=require('bitly');constbitly=newBitlyClient('<accessToken>',{});letresult;try{result=awaitbitly.shorten(uri);}catch(e){throwe;}returnresult;

If you are not usingnode 8 then you can still use the library withPromise values:

constBitlyClient=require('bitly').BitlyClient;constbitly=newBitlyClient('<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 accesstoken to the method

constBitlyClient=require('bitly').BitlyClient;constbitly=newBitlyClient('<accessToken>');try{returnawaitbitly.bitlyRequest('link/referrers_by_domain',{link:'https://github.com/tanepiper/node-bitly',unit:'hour',timezone:'Europe/Amsterdam'});}catch(e){throwe;}

To run tests typenpm test.

The tests usereplay, which caches the responses from Bitly under the/fixtures directory, until you edit a test's requests payload. This means you can run the test suite without having a Bitly API key, until you need to edit or add a new test.

Once you need to run tests that can't use a cached response and actually hit Bitly's API, you will need to pass your API key to the tests by having an environment variableBITLY_API_KEY set to the value of your key.