# sync-hooks

> Function to install a batch of GitHub event hooks at once

Latest version **0.1.8** (published 2014-05-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install sync-hooks
pnpm add sync-hooks
yarn add sync-hooks
bun add sync-hooks
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2014-05-15 |
| First published | 2014-01-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Paul Sweeney |
| Maintainers | 8bitdesigner, azaeres, jeffuyeno |

## Links

- npm: https://www.npmjs.com/package/sync-hooks
- Repository: https://github.com/8bitDesigner/sync-hooks
- Issues: https://github.com/8bitDesigner/sync-hooks/issues
- npm.io page: https://npm.io/package/sync-hooks

## Dependencies (3)

- [async](https://npm.io/package/async.md) ~0.2.10
- [underscore](https://npm.io/package/underscore.md) ~1.5.2
- [node-github](https://npm.io/package/node-github.md) 0.0.3

## Recent versions

- 0.1.8 (latest) — 2014-05-15
- 0.1.7 — 2014-01-27
- 0.1.6 — 2014-01-27
- 0.1.5 — 2014-01-24
- 0.1.4 — 2014-01-24
- 0.1.3 — 2014-01-24
- 0.1.2 — 2014-01-24
- 0.1.1 — 2014-01-24

## README

# What is this thing?
This node module exposes a function for configuring event hooks in GitHub.

## How do I use this!?

``` javascript
var syncHooks = require('sync-hooks')

syncHooks({

  // This URL will be pinged by GitHub when one of your configured events triggers
  url: 'http://my.build.server.com/'

  // This is a GitHub authentication object, for more information on its options
  // see https://github.com/ajaxorg/node-github#authentication
  auth: {
    type: 'oauth',
    token: '12356' // Generated from here: https://github.com/settings/applications
  },

  // A hash of repositories on the left, to arrays of events to listen to on
  // the right
  eventsHash: {
    'fullscreeninc/my-project': ['pull_request', 'issues', 'push'],
    '8bitDesigner/socks': ['issues'],
    'ryancbarry/isawesome': ['push']
  }
, function(err, hooks) {
  // Do something now that your awesome GitHub hooks are installed
})
```

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