jenkins-rxjs
A library for executing Jenkins Jobs with RxJs listeners
✨ Features
- runs entire jenkins job process
- returns stream of observables
🔧 Installation
yarn add jenkins jenkins-rxjs
🎬 Getting started
Let's demonstrate simple usage with an example:
import * as createJenkins from 'jenkins';
import { JenkinsRxJs } from 'jenkins-rxjs';
const jenkinsPromisified = createJenkins({
baseUrl: myJenkinsUrl,
promisify: true,
});
const jenkinsRxJs = new JenkinsRxJs(jenkinsPromisified);
jenkinsRxJs.run(jobBuildOptions).subscribe(console.log);
🎭 Examples
Go checkout adeng-jenkins-cli and jenkins-jobs-runner for examples of integration.
📜 API
Full API can be found here.
🕵️ Troubleshooting
🥂 License
MIT as always
Type aliases
JobStatus
JobStatus: "FAILURE" | "SUCCESS" | "PROGRESS"
ResultType
ResultType: "FAILURE" | "SUCCESS"
Variables
Const overestimateThreshold
overestimateThreshold: 15000 = 15000
Const pessimisticThreshold
pessimisticThreshold: 4000 = 4000
Functions
delay
- delay(milliseconds: number): Promise<void>
-
Parameters
Returns Promise<void>
getJobProgressElapsedTime
- getJobProgressElapsedTime(response: JobProgress): number
-
Parameters
Returns number
getJobProgressEstimatedDuration
- getJobProgressEstimatedDuration(response: JobProgress): number
-
Parameters
Returns number
getJobProgressEstimatedRemainingTime
- getJobProgressEstimatedRemainingTime(response: JobProgress): number
-
Parameters
Returns number
getJobProgressPercentage
- getJobProgressPercentage(response: JobProgress): number
-
Parameters
Returns number
getQueueItemRemainingDuration
- getQueueItemRemainingDuration(response: QueueItem): number
-
Parameters
Returns number
isJobDone
-
Parameters
Returns boolean
isJobProgress
-
Parameters
Returns boolean
isQueueItemDone
- isQueueItemDone(response: QueueItem): boolean
-
Parameters
Returns boolean
isQueueItemQueued
- isQueueItemQueued(response: QueueItem): boolean
-
Parameters
Returns boolean
isQueueItemQuiet
- isQueueItemQuiet(response: QueueItem): boolean
-
Parameters
Returns boolean