https://github.com/jonschlinkert/orgs
Get publicly available information about an organization, or for all organizations for one or more users, from the GitHub API.
https://github.com/jonschlinkert/orgs
api github javascript js login node nodejs organizations orgs user
Last synced: 10 months ago
JSON representation
Get publicly available information about an organization, or for all organizations for one or more users, from the GitHub API.
- Host: GitHub
- URL: https://github.com/jonschlinkert/orgs
- Owner: jonschlinkert
- License: mit
- Created: 2018-08-19T10:30:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-19T10:30:43.000Z (over 7 years ago)
- Last Synced: 2025-04-13T14:07:40.841Z (10 months ago)
- Topics: api, github, javascript, js, login, node, nodejs, organizations, orgs, user
- Language: JavaScript
- Size: 9.77 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# orgs [](https://www.npmjs.com/package/orgs) [](https://npmjs.org/package/orgs) [](https://npmjs.org/package/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](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```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
```
### [.get](index.js#L71)
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);
```
### [.user](index.js#L89)
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);
```
### [.users](index.js#L106)
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);
```
### [.userOrgs](index.js#L123)
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);
```
### [.all](index.js#L142)
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
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](.github/contributing.md) 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:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Author
**Jon Schlinkert**
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on August 19, 2018._