History

anaarmas 28ccc3db2d Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)		2020-04-28 17:23:37 +02:00
..
dist-node	Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)	2020-04-28 17:23:37 +02:00
dist-src	Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)	2020-04-28 17:23:37 +02:00
dist-types	Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)	2020-04-28 17:23:37 +02:00
dist-web	Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)	2020-04-28 17:23:37 +02:00
LICENSE	Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)	2020-04-28 17:23:37 +02:00
package.json	Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)	2020-04-28 17:23:37 +02:00
README.md	Initial commit (from f5274cbdce4ae7c9e4b937dcdf95ac70ae436d5f)	2020-04-28 17:23:37 +02: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