# github-jobs

> Github Jobs API module

Latest version **0.1.0** (published 2016-01-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-jobs
pnpm add github-jobs
yarn add github-jobs
bun add github-jobs
```

## 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.0 |
| Published | 2016-01-08 |
| First published | 2014-05-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Peter DeMartini |
| Maintainers | peterdemartini |
| Keywords | Github, Jobs, API, REST |

## Links

- npm: https://www.npmjs.com/package/github-jobs
- Repository: https://github.com/peterdemartini/github-jobs
- Issues: https://github.com/peterdemartini/github-jobs/issues
- npm.io page: https://npm.io/package/github-jobs

## Dependencies (4)

- [q](https://npm.io/package/q.md) ^1.4.1
- [urijs](https://npm.io/package/urijs.md) ^1.17.0
- [lodash](https://npm.io/package/lodash.md) ~2.4.1
- [restler](https://npm.io/package/restler.md) ~3.2.2

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2016-01-08
- 0.0.5 — 2014-05-21
- 0.0.4 — 2014-05-19
- 0.0.3 — 2014-05-11
- 0.0.2 — 2014-05-11
- 0.0.1 — 2014-05-10

## README

Github Jobs API
===========

NPM module for Github Jobs API [https://jobs.github.com/api](https://jobs.github.com/api)

## Installation:

````
npm install github-jobs
````

### Require

````
var jobs = require('github-jobs');
````


## API

### Find

Search for positions

````
jobs.find([params], [callback]);//Return a promise
````

#### Parameters:

**page :** Used for pagination (optional) [default = 0]

**timeout :** Timeout in milliseconds (optional) [default = 10000]

**term :** A search term, such as "ruby" or "java". This parameter is aliased to search. (optional)

**location :**  A city name, zip code, or other location search term.
 A city name, zip code, or other location search term. (optional)

**lat :**  A specific latitude. If used, you must also send long and must not send location. (optional)

**long :** A specific longitude. If used, you must also send lat and must not send location. (optional)

**full_time :** If you want to limit results to full time positions set this parameter to 'true'. (optional)

#### Callback:

````
function(err, jobs){
    ...
}
````

### Find By Id

Find a position by the position id.

```javascript
jobs.findById(id, [callback]);//Return a promise
```


### Full Example

* With Promise

```javascript
    var jobs = require('github-jobs');
    jobs.find({
        term : 'Node.js'
    }).then(function(results){
        console.log('Found ' + results.length + ' jobs.');
        results.forEach(function(job){
            jobs.findById(job.id).then(function(result){
                console.log('Job : ', result);
            }).catch(function(err){
              console.log('Error: ', err);
            });
        });
    }).catch(function(err){
      console.log('Error: ', err);
    });
```

* With callback

```javascript
    var jobs = require('github-jobs');

    jobs.find({
        term : 'Node.js'
    }, function(err, results){
        if(err){
            return console.log('Error: ', err);
        }

        console.log('Found ' + results.length + ' jobs.');

        results.forEach(function(job){
            jobs.findById(job.id, function(err, result){
                if(err){
                    return console.log('Error: ', err);
                }
                console.log('Job : ', result);
            });
        });
    });
```
## How to contribute
Please check all tests after submit a merge request.

To run unit tests execute in the project folder execute
```bash
  node_modules/mocha/bin/mocha test/
```

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