# github-api-wrapper

> A wrapper to work with Github API

Latest version **2.4.2** (published 2017-11-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-api-wrapper
pnpm add github-api-wrapper
yarn add github-api-wrapper
bun add github-api-wrapper
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.4.2 |
| Published | 2017-11-24 |
| First published | 2017-11-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Paula Junqueira Bastos |
| Maintainers | paulajbastos |

## Links

- npm: https://www.npmjs.com/package/github-api-wrapper
- npm.io page: https://npm.io/package/github-api-wrapper

## Recent versions

- 2.4.2 (latest) — 2017-11-24
- 2.4.1 — 2017-11-24
- 2.4.0 — 2017-11-24
- 2.3.0 — 2017-11-24
- 2.2.0 — 2017-11-22
- 2.1.0 — 2017-11-15
- 2.0.0 — 2017-11-14
- 1.0.1 — 2017-11-09
- 1.0.0 — 2017-11-07

## README

# Github API Wrapper

A wrapper to work with the [Github Web API](https://api.github.com).

## Browser Support

This library relies on [Fetch API](https://fetch.spec.whatwg.org/). And this API is supported in the following browsers.

![Chrome](https://cloud.githubusercontent.com/assets/398893/3528328/23bc7bc4-078e-11e4-8752-ba2809bf5cce.png) | ![Firefox](https://cloud.githubusercontent.com/assets/398893/3528329/26283ab0-078e-11e4-84d4-db2cf1009953.png) | ![Opera](https://cloud.githubusercontent.com/assets/398893/3528330/27ec9fa8-078e-11e4-95cb-709fd11dac16.png) | ![Safari](https://cloud.githubusercontent.com/assets/398893/3528331/29df8618-078e-11e4-8e3e-ed8ac738693f.png) | ![IE](https://cloud.githubusercontent.com/assets/398893/3528325/20373e76-078e-11e4-8e3a-1cb86cf506f0.png) |
--- | --- | --- | --- | --- |
39+ ✔ | 42+ ✔ | 29+ ✔ | 10.1+ ✔ | Nope ✘ |

## Dependencies

This library depends on [fetch](https://fetch.spec.whatwg.org/) to make requests to the Spotify Web API. For environments that don't support fetch, you'll need to provide a [polyfill](https://github.com/github/fetch) to browser or [polyfill](https://github.com/bitinn/node-fetch) to Node.


## Installation

```sh
$ npm install github-api-wrapper --save
```

## How to use

### ES6

```js
// to import a specific method
import GithubApiWrapper from 'github-api-wrapper';

const github = new GithubApiWrapper({});
Will setup 'mundipagg' as default

or use as you want:

const github = new GithubApiWrapper({
  userName: 'paulajbastos'
});

// using  method
github.repositories.getRepoList();
github.commits.getCommitsList('repoName');
github.contributors.getContributorsList('repoName');
```

### CommonJS

```js
const githubApiWrapper = require('github-api-wrapper');
```

### UMD in Browser

```html
<!-- to import non-minified version -->
<script src="github-api-wrapper.umd.js"></script>

<!-- to import minified version -->
<script src="github-api-wrapper.umd.min.js"></script>
```

After that the library will be available to the Global as `githubApiWrapper`. Follow an example:


## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).


## Authors

| [Paula Junqueira Bastos]|
|:---------------------:|
|  [Paula Junqueira Bastos](https://bitbucket.org/paulajbastos/)   |

See also the list of [contributors](https://bitbucket.org/paulajbastos/github-api-wrapper/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

---
_Source: https://npm.io/package/github-api-wrapper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._