orgs

Get publicly available information about an organization, or for all organizations for one or more users, from the GitHub API.

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

Install

Install with npm:

$ npm install --save orgs

Usage

const orgs = require('orgs');

API

Params

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

Example

const orgs = require('orgs');

// see github-base for other authentication options
orgs(['doowb', 'jonschlinkert'], { token: 'YOUR_GITHUB_AUTH_TOKEN' })
  .then(orgs => {
    // array of organization objects from the GitHub API
    console.log(orgs);
  })
  .catch(console.error)l

.get

Get publicly available information about the given GitHub organization. Equivalent to GET /orgs/:orgname.

Params

• name {String}: GitHub organization name.
• options {Object}
• returns {object}: Response object with information about the organization.

Example

const orgs = require('orgs');
orgs.get('micromatch', { token: 'YOUR_GITHUB_AUTH_TOKEN' })
  .then(res => console.log(res))
  .catch(console.error);

.user

Get publicly available information about the given GitHub user. Equivalent to GET /users/:username.

Params

• user {String}: GitHub username.
• options {Object}
• returns {object}: Response object with array of orgs on res.orgs.

Example

const orgs = require('orgs');
orgs.user('doowb', { token: 'YOUR_GITHUB_AUTH_TOKEN' })
  .then(res => console.log(res.orgs))
  .catch(console.error);

.users

Get publicly available information about all GitHub users. Equivalent to a paginated request to GET /users.

Params

• options {Object}
• returns {object}: Response object with array of orgs on res.orgs.

Example

const orgs = require('orgs');
orgs.users({ token: 'YOUR_GITHUB_AUTH_TOKEN' })
  .then(res => console.log(res))
  .catch(console.error);

.userOrgs

Get an array of orgs for the given user. Equivalent to GET /users/:username.

Params

• user {String}
• options {Object}
• returns {object}: Response object with array of orgs on res.orgs.

Example

const orgs = require('orgs');
orgs.userOrgs('doowb', { token: 'YOUR_GITHUB_AUTH_TOKEN' })
  .then(res => console.log(res))
  .catch(console.error);

.all

Get a list of objects with information for all publicly available GitHub organizations. Equivalent to a paginated request to GET /organizations.

Params

• options {Object}
• returns {object}: Response object with array of orgs on res.orgs.

Example

const orgs = require('orgs');
orgs.all({ token: 'YOUR_GITHUB_AUTH_TOKEN' })
  .then(res => console.log(res))
  .catch(console.error);

About

Contributing

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

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

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

Author

Jon Schlinkert

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

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.