@theholocron/jira-client
v1.5.3
Published
A TypeScript client for the Jira REST API
Maintainers
Readme
@theholocron/jira-client
TypeScript client for the Jira REST API v2. Covers issues, versions, projects, links, transitions, and search.
Installation
pnpm add @theholocron/jira-clientUsage
import { createJiraClient } from "@theholocron/jira-client";
const jira = createJiraClient({
host: "https://your-org.atlassian.net/rest/api/2",
token: Buffer.from(`${email}:${apiToken}`).toString("base64"),
});
// Create a ticket
const issue = await jira.issues.create("Fix login bug", "Bug", "PROJ");
// Get multiple tickets
const issues = await jira.issues.getMany(["PROJ-1", "PROJ-2"]);
// Search with JQL
const results = await jira.issues.search({
jql: "project = PROJ AND status = Open",
});
// Manage versions
const version = await jira.versions.create("v1.2.0", "PROJ");
await jira.versions.update(version.id, { released: true });API
jira.issues— create, get, getMany, update, getProperty, searchjira.versions— create, get, getMany, update, deletejira.projects— getjira.links— create, createMany, getLinkTypesjira.transitions— create, get, getResolutions
Auth
Jira REST API v2 uses HTTP Basic auth with a base64-encoded email:apiToken string. Generate an API token at id.atlassian.com/manage-profile/security/api-tokens.
License
GPL-3.0 © Newton Koumantzelis
