tree: 356664a048daaac06a75ce5df346d7d5c742bf59 [path history] [tgz]
  1. lib/
  2. node_modules/
  3. plugins/
  4. index.d.ts
  5. index.js
  6. LICENSE
  7. package.json
  8. README.md
setup-maven/node_modules/@octokit/rest/README.md

rest.js

GitHub REST API client for JavaScript

@latest Build Status Greenkeeper

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