History

Rachael Sewell 714607abe9 Add node modules and package files		2019-09-06 15:17:38 -07:00
..
lib	Add node modules and package files	2019-09-06 15:17:38 -07:00
node_modules/universal-user-agent	Add node modules and package files	2019-09-06 15:17:38 -07:00
plugins	Add node modules and package files	2019-09-06 15:17:38 -07:00
LICENSE	Add node_modules	2019-08-06 21:05:52 -07:00
README.md	Add node_modules	2019-08-06 21:05:52 -07:00
index.d.ts	Add node_modules	2019-08-06 21:05:52 -07:00
index.js	Add node_modules	2019-08-06 21:05:52 -07:00
package.json	Add node modules and package files	2019-09-06 15:17:38 -07:00

README.md

rest.js

GitHub REST API client for JavaScript

Installation

npm install @octokit/rest

Usage

const Octokit = require('@octokit/rest')
const octokit = new Octokit()

// Compare: https://developer.github.com/v3/repos/#list-organization-repositories
octokit.repos.listForOrg({
  org: 'octokit',
  type: 'public'
}).then(({ data }) => {
  // handle data
})

See https://octokit.github.io/rest.js/ for full documentation.

Contributing

We would love you to contribute to @octokit/rest, pull requests are very welcome! Please see CONTRIBUTING.md for more information.

Credits

@octokit/rest was originally created as node-github in 2012 by Mike de Boer from Cloud9 IDE, Inc.

It was adopted and renamed by GitHub in 2017

LICENSE

MIT