History

Danny McCormick feb12fe291 new toolkit and scoped registries		2019-08-05 15:18:52 -04:00
..
lib	new toolkit and scoped registries	2019-08-05 15:18:52 -04:00
node_modules/universal-user-agent	new toolkit and scoped registries	2019-08-05 15:18:52 -04:00
plugins	new toolkit and scoped registries	2019-08-05 15:18:52 -04:00
LICENSE	new toolkit and scoped registries	2019-08-05 15:18:52 -04:00
README.md	new toolkit and scoped registries	2019-08-05 15:18:52 -04:00
index.d.ts	new toolkit and scoped registries	2019-08-05 15:18:52 -04:00
index.js	new toolkit and scoped registries	2019-08-05 15:18:52 -04:00
package.json	new toolkit and scoped registries	2019-08-05 15:18:52 -04: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