@octokit/rest

GitHub REST API client for Node.js

Last updated 5 years ago by octokitbot .

MIT · Repository · Bugs · Original npm · Tarball · package.json

$ npm install @octokit/rest

SYNC missed versions from official npm registry.

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

Current Tags

21.0.0-beta.4 ... beta (6 months ago)
15.18.1 ... deprecations-for-v16 (6 years ago)
21.0.2 ... latest (4 months ago)
15.18.3 ... release-15.x (5 years ago)
16.43.2 ... release-16.x (5 years ago)
17.11.0 ... release-17.x (5 years ago)
18.12.0 ... release-18.x (3 years ago)
19.0.13 ... release-19.x (2 years ago)
20.1.0 ... release-20.x (9 months ago)

297 Versions

Maintainers (3)

Downloads

Total 4

Today 0

This Week 0

This Month 0

Last Day 0

Last Week 0

Last Month 0

Dependencies (4)

@octokit/core ^2.4.0
@octokit/plugin-paginate-rest ^2.0.0
@octokit/plugin-request-log ^1.0.0
@octokit/plugin-rest-endpoint-methods 3.0.0-beta.2

Dev Dependencies (23)

@octokit/auth ^1.1.1
@octokit/fixtures-server ^6.0.0
@octokit/request ^5.2.0
@pika/pack ^0.5.0
@pika/plugin-build-node ^0.8.1
@pika/plugin-build-web ^0.8.1
@pika/plugin-ts-standard-pkg ^0.8.1
@types/node ^13.1.0
btoa-lite ^1.0.0
chai ^4.1.2
cypress ^3.0.0
mocha ^7.0.1
nock ^11.3.3
nyc ^15.0.0
prettier ^1.14.2
proxy ^1.0.0
semantic-release ^17.0.0
semantic-release-plugin-update-version-in-files ^1.0.0
sinon ^8.0.0
sinon-chai ^3.0.0
string-to-arraybuffer ^1.0.0
typescript ^3.7.5
universal-user-agent ^4.0.0

Dependents (14)

© 2010 - cnpmjs.org x YWFE | Home | YWFE