Socket
Socket
Sign inDemoInstall

bitbucket-v2

Package Overview
Dependencies
2
Maintainers
3
Versions
25
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    bitbucket-v2

Wrapper for the BitBucket API v2, the version required to use OAuth2. Includes support for custom HTTP clients.


Version published
Weekly downloads
335
increased by55.09%
Maintainers
3
Install size
1.50 MB
Created
Weekly downloads
 

Readme

Source

node-bitbucket-v2

node.js library to access the Bitbucket API v2

usage

Not supported for Node < 7.6

const Bitbucket = require('node-bitbucket-v2');
const bitbucketApi = new Bitbucket(options);
bitbucketApi.authenticateOAuth2(accessTokenString);

bitbucketApi.user.get().then(({ body }) => {
  console.log(body.uuid);
});

options

It is not necessary to provide any options at all (Bitbucket can be constructed with no argument).

  • requesterFn ((options) => Promise<any>): If provided, requests will be made using the function you provide. This is allows you to use your preferred http client. The options provided are { headers, hostname, method, path, query, url, body? }. body is only provided on POST methods. In the case of getNextPage, getPreviousPage, getForksFromResponse and getParentFromResponse, only { headers, method, url } are provided in the options. Example:
 const axios = require('axios');
 const Bitbucket = require('node-bitbucket-v2');

 const requesterFn = (options) => {
   const { url, method, body } = options;

   if (method === 'POST') {
     return axios.post(url, body);
   }

   return axios.get(url);
 };

 const bitbucketApi = new Bitbucket({ requesterFn });
  • proxy (String): Defines a proxy to make requests against, instead of api.bitbucket.org:443. This option is ignored when requesterFn is provided.

For implemented methods, check bitbucket/repositories.js and bitbucket/user.js.

FAQs

Last updated on 03 Feb 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc