Socket
Socket
Sign inDemoInstall

repos

Package Overview
Dependencies
32
Maintainers
2
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    repos

Tiny wrapper around github-base for getting publicly available information for a repository, or all of the repositories for one or more users or orgs, from the GitHub API.


Version published
Weekly downloads
57
decreased by-13.64%
Maintainers
2
Install size
1.20 MB
Created
Weekly downloads
 

Changelog

Source

[2.0.0] - 2018-08-19

  • Use the orgs library.

Readme

Source

repos NPM version NPM monthly downloads NPM total downloads

Tiny wrapper around github-base for getting publicly available information for a repository, or all of the repositories for one or more users or orgs, from the GitHub API.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save repos

Release history

See the changelog for updates.

Usage

This library is a tiny wrapper around github-base, see that project's readme for more information about available options and authentication choices.

Params

  • users {String|Array}: One or more users or organization names.
  • options {Object}: See available options.
  • returns {Promise}

Example

const repos = require('repos');
const options = {
  // see github-base for other authentication options
  token: 'YOUR_GITHUB_AUTH_TOKEN'
};
repos(['doowb', 'jonschlinkert'], options)
  .then(function(repos) {
    // array of repository objects
    console.log(repos);
  })
  .catch(console.error)

See the GitHub API documentation for repositories for more details about the objects returned for each repository.

Options

OptionTypeDefaultDescription
filterOrgsfunctionundefinedFunction for filtering organizations from the result.
filterReposfunctionundefinedFunction for filtering repositories from the result.
sortbooleantrueBy default, the returned list is sorted by repository name

CLI

$ repos <names> <dest>
  • names - one or more comma-separated user names or orgs
  • dest - destination path to use, default is repos.json

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

You might also be interested in these projects:

Author

Jon Schlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on August 19, 2018.

Keywords

FAQs

Last updated on 19 Aug 2018

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