# node-async-jenkins-api

> jenkins api client support async

Latest version **1.3.0** (published 2020-08-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install node-async-jenkins-api
pnpm add node-async-jenkins-api
yarn add node-async-jenkins-api
bun add node-async-jenkins-api
```

## 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 | 1.3.0 |
| Published | 2020-08-11 |
| First published | 2020-03-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 11.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Jason916 |
| Maintainers | jasonxu1989 |
| Keywords | jenkins, async, node, await |

## Links

- npm: https://www.npmjs.com/package/node-async-jenkins-api
- Repository: https://github.com/Jason916/node-async-jenkins-api
- Homepage: https://github.com/Jason916/node-async-jenkins-api#readme
- Issues: https://github.com/Jason916/node-async-jenkins-api/issues
- npm.io page: https://npm.io/package/node-async-jenkins-api

## Dependencies (2)

- [moment](https://npm.io/package/moment.md) ^2.22.2
- [request](https://npm.io/package/request.md) ^2.88.2

## Alternatives

- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads

## Recent versions

- 1.3.0 (latest) — 2020-08-11
- 1.2.2 — 2020-06-09
- 1.2.1 — 2020-06-03
- 1.2.0 — 2020-06-02
- 1.1.0 — 2020-06-01
- 1.0.2 — 2020-03-31
- 1.0.1 — 2020-03-31
- 1.0.0 — 2020-03-30

## README

# node-async-jenkins-api
Call Jenkins API with JavaScript

## Install
npm install node-async-jenkins-api

## Usage

#### Setup
```javascript
const Jenkins = require('node-async-jenkins-api');
const jenkins = new Jenkins({
  url: 'jenkinsUrl',
  username: 'jenkinsUsername',
  password: 'jenkinsPassword/jenkinsToken'
});
```

#### build
``` 
const result = await jenkins.build(jobName)
```

#### buildWithParams
```
const result = await jenkins.buildWithParams(jobName, params)
```

#### getQueueItemInfo
```
const result = await jenkins.getQueueItemInfo(queueId)
```

#### cancelQueueItem
```
const result = await jenkins.cancelQueueItem(queueId)
```

#### getQueueInfo
```
const result = await jenkins.getQueueInfo()
```

#### getLastBuildInfo
```
const result = await jenkins.getLastBuildInfo(jobName)
```

#### getJobInfo
```
const result = await jenkins.getJobInfo(jobName)
```


#### stopBuild
```
const result = await jenkins.stopBuild(jobName, buildNumber)
```

#### buildInfo
```
const result = await jenkins.buildInfo(jobName, buildNumber)
```

#### allJobsInView
```
const result = await jenkins.allJobsInView(viewName)
```

#### getBuildingProcess
```
const result = await jenkins.getBuildingProcess(jobName)
```

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