jira-client

What is jira-client?

The jira-client npm package is a Node.js wrapper for the JIRA REST API. It allows developers to interact with JIRA programmatically, enabling them to automate tasks, retrieve data, and manage JIRA issues, projects, and other resources.

What are jira-client's main functionalities?

Create Issue

This feature allows you to create a new issue in JIRA. The code sample demonstrates how to configure the jira-client and create a new issue with specified fields such as project key, summary, description, and issue type.

const JiraClient = require('jira-client');

const jira = new JiraClient({
  protocol: 'https',
  host: 'your-jira-host.atlassian.net',
  username: 'your-username',
  password: 'your-password',
  apiVersion: '2',
  strictSSL: true
});

jira.addNewIssue({
  fields: {
    project: { key: 'TEST' },
    summary: 'New issue from jira-client',
    description: 'Creating an issue via jira-client',
    issuetype: { name: 'Task' }
  }
}).then(issue => {
  console.log(`Created issue: ${issue.key}`);
}).catch(err => {
  console.error(err);
});

Get Issue

This feature allows you to retrieve details of a specific issue by its key. The code sample shows how to configure the jira-client and fetch an issue using its key.

const JiraClient = require('jira-client');

const jira = new JiraClient({
  protocol: 'https',
  host: 'your-jira-host.atlassian.net',
  username: 'your-username',
  password: 'your-password',
  apiVersion: '2',
  strictSSL: true
});

jira.findIssue('TEST-1').then(issue => {
  console.log(`Found issue: ${issue.key}`);
  console.log(issue);
}).catch(err => {
  console.error(err);
});

Update Issue

This feature allows you to update an existing issue in JIRA. The code sample demonstrates how to configure the jira-client and update the summary and description of an issue using its key.

const JiraClient = require('jira-client');

const jira = new JiraClient({
  protocol: 'https',
  host: 'your-jira-host.atlassian.net',
  username: 'your-username',
  password: 'your-password',
  apiVersion: '2',
  strictSSL: true
});

jira.updateIssue('TEST-1', {
  fields: {
    summary: 'Updated summary',
    description: 'Updated description'
  }
}).then(issue => {
  console.log(`Updated issue: ${issue.key}`);
}).catch(err => {
  console.error(err);
});

Search Issues

This feature allows you to search for issues in JIRA using JQL (JIRA Query Language). The code sample shows how to configure the jira-client and perform a search for issues in a specific project with a specific status.

const JiraClient = require('jira-client');

const jira = new JiraClient({
  protocol: 'https',
  host: 'your-jira-host.atlassian.net',
  username: 'your-username',
  password: 'your-password',
  apiVersion: '2',
  strictSSL: true
});

jira.searchJira('project = TEST AND status = "To Do"').then(result => {
  console.log('Search results:', result.issues);
}).catch(err => {
  console.error(err);
});

Other packages similar to jira-client

jira-connector

The jira-connector package is another Node.js wrapper for the JIRA REST API. It provides similar functionalities to jira-client, such as creating, updating, and searching for issues. However, jira-connector offers a more modular approach, allowing developers to include only the parts of the API they need.

atlassian-jira

The atlassian-jira package is a comprehensive library for interacting with JIRA's REST API. It supports a wide range of JIRA functionalities, including issue management, project management, and user management. Compared to jira-client, atlassian-jira offers more extensive documentation and examples, making it easier for developers to get started.

README

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:

$ npm install jira-client

Examples

Create the JIRA client

// 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
});

Find the status of an issue

// 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/