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 :heart: and support.

Install

Install with npm:

``sh
$ npm install --save orgs
`

Usage

`js
const orgs = require('orgs');
`

API

Params

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

Example

`js
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
`

$3

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

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

$3

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

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

$3

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

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

$3

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

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

$3

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

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

About

$3

Jon Schlinkert

* GitHub Profile
* Twitter Profile
* LinkedIn Profile

$3

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

*

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