JavaScript JIRA API for node.js #

A node.js module, which provides an object oriented wrapper for the Jira Rest API.


Installation ##

Install with the node package manager npm:

``shell
$ npm install jira-client
`

Examples ##

$3

`javascript
// With ES5
var JiraApi = require('jira-client');

// With ES6
import JiraApi from 'jira-client';

// Initialize
var jira = new JiraApi({
protocol: 'https',
host: 'jira.somehost.com',
username: 'username',
password: 'password',
apiVersion: '2',
strictSSL: true
});
`

$3

`javascript
// ES5
// We are using an ES5 Polyfill for Promise support. Please note that if you don't explicitly
// apply a catch exceptions will get swallowed. Read up on ES6 Promises for further details.
jira.findIssue(issueNumber)
.then(function(issue) {
console.log('Status: ' + issue.fields.status.name);
})
.catch(function(err) {
console.error(err);
});

// ES6
jira.findIssue(issueNumber)
.then(issue => {
console.log(Status: ${issue.fields.status.name});
})
.catch(err => {
console.error(err);
});

// ES7
async function logIssueName() {
try {
const issue = await jira.findIssue(issueNumber);
console.log(Status: ${issue.fields.status.name});
} catch (err) {
console.error(err);
}
}

``

Documentation ##

Can't find what you need in the readme? Check out our documentation here: https://jira-node.github.io/