jira.js
適用於 JavaScript 和 TypeScript 的型別安全 Jira REST API 用戶端。支援 Jira Cloud、Data Center、Agile、Service Management、Assets、Teams 及組織 API。
jira.js 是什麼?
適用於 JavaScript 和 TypeScript 的型別安全 Jira REST API 用戶端。支援 Jira Cloud、Data Center、Agile、Service Management、Assets、Teams 及組織 API。執行時期回應驗證、可樹狀搖晃的 ESM、Node.js 與瀏覽器。
jira.js 概覽
這是什麼
jira.js 是一個 TypeScript 用戶端,用於 Atlassian Jira REST API,支援 Jira Cloud 與自託管的 Jira Data Center。它涵蓋 Jira Cloud 平台 API、Jira Agile API、Jira Service Management API、Assets API、Teams API、組織管理 API 以及 Jira Data Center API。此函式庫僅支援 ESM,需要 Node.js 22 或更新版本,並可在現代瀏覽器中使用。它附帶型別定義,僅依賴一個執行期套件(zod)。需要 TypeScript 5.7 或更新版本。此專案使用 MIT 授權,屬於開源軟體。6.0 版為重大改寫;仍使用第 5 版的用戶應在升級前閱讀遷移指南。該函式庫支援 OAuth 2.0 (3LO) 並提供自動權杖刷新,且可透過匯入單一端點函式來實現 tree-shaking。它在執行期根據 schema 驗證回應,並提供帶有謂詞的型別化錯誤層級。
主要功能
- 型別安全:每個端點、參數與模型都有型別;原始碼隨套件發佈,因此「前往定義」可正常運作。
- 執行期驗證:回應會根據 schema 檢查;欄位漂移會按欄位回報。
- 基於 Promise:所有方法都使用 async/await。
- 可 tree-shaking:可匯入單一端點函式而非整個用戶端。
- 通用:一個 ESM 建置即可用於 Node.js 22+ 與現代瀏覽器。
- 單一相依套件:僅需
zod。 - 型別化錯誤,包含能通過捆綁、縮小與重複安裝的謂詞。
使用情境
整合 Jira 實現自動化、Webhook 處理器、CI/CD 管線以及基於瀏覽器的工具。建構自訂儀表板、問題管理、衝刺追蹤、服務台請求處理以及組織管理(使用者、群組、佈建)。
快速開始
bash# 使用 npmnpm install jira.js# 使用 yarnyarn add jira.js# 使用 pnpmpnpm add jira.js快速範例:typescriptimport { createCloudClient } from 'jira.js';const jira = createCloudClient({ host: 'https://your-domain.atlassian.net', auth: { type: 'basic', email: '[email protected]', apiToken: 'YOUR_API_TOKEN', },});const project = await jira.projects.getProject({ projectIdOrKey: 'YOUR_PROJECT_KEY' });const issue = await jira.issues.createIssue({ fields: { summary: 'Hello Jira.js!', issuetype: { name: 'Task' }, project: { key: project.key }, },});console.log(`Issue created: ${issue.key}`);
授權與價格
授權為 MIT。價格類型為開源;未提及額外價格資訊。
內容整理自該專案公開的 README 與儲存庫資訊。