https://github.com/github-tools/github-extended
A collection of methods to extend the functionality of Github.js (known on npm as github-api)
https://github.com/github-tools/github-extended
Last synced: 3 months ago
JSON representation
A collection of methods to extend the functionality of Github.js (known on npm as github-api)
- Host: GitHub
- URL: https://github.com/github-tools/github-extended
- Owner: github-tools
- License: mit
- Created: 2015-12-23T02:03:46.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2022-02-13T15:30:23.000Z (about 4 years ago)
- Last Synced: 2025-08-09T07:10:11.224Z (7 months ago)
- Language: JavaScript
- Size: 196 KB
- Stars: 14
- Watchers: 1
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE.txt
Awesome Lists containing this project
README
# GitHub Extended
[](https://codeclimate.com/github/github-tools/github-extended)
[](https://travis-ci.org/github-tools/github-extended)
[](https://coveralls.io/github/github-tools/github-extended?branch=master)
[GitHub Extended](https://github.com/github-tools/github-extended) is a collection of methods to extend the
functionality of [Github.js](https://github.com/michael/github) (known on [npm](https://www.npmjs.com) as
[github-api](https://www.npmjs.com/package/github-api)).
## Requirements
Being an extension for Github.js, the only requirement is to install and include
[Github.js](https://github.com/michael/github) before
[GitHub Extended](https://github.com/github-tools/github-extended).
## Installation
You can install GitHub Extended by using [npm](https://www.npmjs.com):
```
npm install github-extended
```
Alternatively, you can install it via [Bower](http://bower.io):
```
bower install github-extended --save
```
Another possibility is to manually download it.
## Methods
The sections below describe the methods provided.
### repository.search(string, options = {})
Searches files and folders
### repository.mergePullRequest(pullRequest, options = {})
Merges a pull request
### repository.remove(branchName = 'master', path = '')
Deletes a file or a folder and all of its content from a given branch
### repository.fork()
Creates a fork of the repository
## License
[GitHub Extended](https://github.com/github-tools/github-extended) is dual licensed under
[MIT](http://www.opensource.org/licenses/MIT) and [GPL-3.0](http://opensource.org/licenses/GPL-3.0).
## Author
[Aurelio De Rosa](http://www.audero.it) ([@AurelioDeRosa](https://twitter.com/AurelioDeRosa))