mirror of
https://github.com/JamesIves/github-pages-deploy-action.git
synced 2023-12-15 20:03:39 +08:00
47 lines
1.1 KiB
Markdown
47 lines
1.1 KiB
Markdown
# rest.js
|
|
|
|
> GitHub REST API client for JavaScript
|
|
|
|
[](https://www.npmjs.com/package/@octokit/rest)
|
|
|
|
[](https://greenkeeper.io/)
|
|
|
|
## Installation
|
|
|
|
```shell
|
|
npm install @octokit/rest
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
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](CONTRIBUTING.md) for more information.
|
|
|
|
## Credits
|
|
|
|
`@octokit/rest` was originally created as [`node-github`](https://www.npmjs.com/package/github) in 2012 by Mike de Boer from Cloud9 IDE, Inc.
|
|
|
|
It was adopted and renamed by GitHub in 2017
|
|
|
|
## LICENSE
|
|
|
|
[MIT](LICENSE)
|