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

github-rest

v0.0.4

Published

GitHub API based on GitHub REST API v3.

Downloads

7

Readme

github-rest

GitHub API based on GitHub REST API v3.

Table of contents

Links

Get Started

Class

const Rest = require('github-rest');
const rest = new Rest(/* token */ '<YOUR_PERSONAL_ACCESS_TOKEN>');
rest.createRepository({ name: '<REPO_NAME>'})
	.then(repo => { /* ... */ })
	.catch(err => { /* ... */ })

Standalone Function

const createRepository = require('github-rest/createRepository');

const options = {
	token: '<YOUR_PERSONAL_ACCESS_TOKEN>',
	name: '<REPO_NAME>',
	// ...
};

createRepository(options)
	.then(repo => { /* ... */ })
	.catch(err => { /* ... */ })
	;

API

  • Class Rest(string token)
  • Promise(Object) <rest>.createRepository(Object options)
  • Promise(null) <rest>.deleteRepository(Object options)
  • Promise(Object[]) <rest>.findRepositories(Object options)
  • Promise(Object) <rest>.getRepository(Object options)
  • Promise(Object) <rest>.whoami(Object options)

All methods are asynchronous and will return instances of Promise. Hereafter, response means what to be obtained in .then((response) => { /* ... */ }).

All methods may be required and invoked by itself as what we see in Get Started, Standalone Function.

createRepository

Response metadata of the just created repository.

deleteRepository

  • options.token string
  • options.username string OPTIONAL
  • options.name string

Delete repository one by once. If successfully executed (whether the repository deleted, or had been deleted before, or does not exist at all), null will be responsed. Otherwise, an error will be thrown and you should use .catch() to catch it.

findRepositories

  • options.token string
  • options.orgname string OPTIONAL
  • options.username string OPTIONAL
  • options.name string OPTIONAL

Response an array. Each item contains metadata of a matching repository.

  • options.orgname and options.username SHOULD be fullname, while options.name is piece of name of target repositories.
  • If options.name absent while options.username or options.orgname present, all repositories belong to the organization or user will be responsed.
  • If options.name absent while both options.username and options.orgname present, the latter one will be ignored.
  • ATTNETION: If there are too many repositoies matched, only the leading ones will be responsed.

getRepository

  • options.token string
  • options.username string OPTIONAL
  • options.name string

Response metadata of the repository.

whoami

  • options.token string

Response metadata of the user who is the owner of the token.

Examples

References