History

Automated Version Bump bfd3ded023 ci: commit dependencies		2021-08-07 21:20:18 +00:00
..
lib	ci: commit dependencies	2021-08-07 21:20:18 +00:00
node_modules/universal-user-agent	ci: commit dependencies	2021-08-07 21:20:18 +00:00
plugins	ci: commit dependencies	2021-08-07 21:20:18 +00:00
LICENSE	ci: commit dependencies	2021-08-07 21:20:18 +00:00
README.md	ci: commit dependencies	2021-08-07 21:20:18 +00:00
index.d.ts	ci: commit dependencies	2021-08-07 21:20:18 +00:00
index.js	ci: commit dependencies	2021-08-07 21:20:18 +00:00
package.json	ci: commit dependencies	2021-08-07 21:20:18 +00: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