npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

pr-list

v0.5.0

Published

An interface for querying a list of PR's from Bitbucket.

Downloads

10

Readme

pr-list

An interface for querying a list of PR's from Bitbucket.

Install

$ yarn add pr-list

Usage

const getPRList = require('pr-list');

(async () => {
  const { repos, prs } = await getPRList({
    workspace: 'renddslow',
  });
})();

A note: This package was built with reporting in mind, and is not intended to be used in user-facing applications. The Bitbucket API is quite good with a very helpful interface, so I would recommend using that instead of this if you want to fetch information on the fly in you application.

API

prList(options)

Returns a Promise for an object with all the matching repos, PRs, and a method for getting the diff-stats for each PR.

  • repos: An array of Bitbucket repository objects
  • prs: An array of Bitbucket PR objects
  • getDiffStats: A method that returns a Promise for an array of Bitbucket diff-stat objects. Takes an optional filter callback as a first argument, and an optional query string addendum as a second.
  • getApprovers: A method that returns a Promise for an array of Bitbucket pullrequest participants. Takes an optional filter callback as a first argument, and an optional query string addendum as a second.

options

For convenience, username, password, and workspace can all be injected as environmental variables as USERNAME, PASSWORD, and WORKSPACE respectively.

username

Type: string

Your Bitbucket username.

password

Type: string

Your Bitbucket app password.

since

Type: ISO-8601 Datetime String

When present, the repos and pullrequests queried will all occur on or after the since time.

state

Type: "MERGED" | "SUPERSEDED" | "OPEN" | "DECLINED"

When present, the pullrequests returned will be limited to the provided state.