Skip to content
Please note that GitHub no longer supports your web browser.

We recommend upgrading to the latest Google Chrome or Firefox.

Learn more
GitHub REST API client for JavaScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github ci(workflow): actually run docs deploy action :) Apr 15, 2019
assets docs(HOW_IT_WORKS): initial version Jan 17, 2018
docs docs: extended usage example May 1, 2019
lib refactor: previews constructor option Mar 14, 2019
plugins feat: apps.deleteInstallation({ installation_id }) (#1342) Apr 19, 2019
scripts build(generate-routes): remove workarounds that have been moved to oc… Apr 16, 2019
test test: throw 400 Bad Request error when `octokit.issues.get()` without… Apr 17, 2019
.gitignore build: remove obsolete artefacts for flow types Nov 17, 2018
.travis.yml ci: remove obsolete docs deploy Apr 15, 2019
CODE_OF_CONDUCT.md chore(Code of Conduct): contributor covenant (#603) Oct 17, 2017
CONTRIBUTING.md build: remove obsolete artefacts for flow types Nov 17, 2018
HOW_IT_WORKS.md docs(HOW_IT_WORKS): update links Jan 23, 2019
LICENSE docs(LICENSE): 2018 Feb 10, 2018
README.md docs: move documentation from README.md to documentation website Apr 30, 2019
cypress.json ci(cypress): rename configuration for cypress v3 Jun 1, 2018
index.js
package-lock.json chore(package): update lockfile package-lock.json Apr 30, 2019
package.json fix(package): update @octokit/request to version 3.0.1 Apr 30, 2019

README.md

rest.js

GitHub REST API client for JavaScript

@latest Build Status Coverage Status Greenkeeper

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

You can’t perform that action at this time.