Class JiraClient

Main entry point for the Jira Data Center REST API client.

Example

const jira = new JiraClient({
  apiUrl: 'https://jira.example.com',
  user: 'pilmee',
  token: 'my-token',
});

// Search issues with JQL
const results = await jira.search({ jql: 'project = PROJ AND status = Open', maxResults: 50 });

// Get a single issue
const issue = await jira.issue('PROJ-42');

// Get issue comments
const comments = await jira.issue('PROJ-42').comments();

// Get issue changelog
const changelog = await jira.issue('PROJ-42').changelog();

// Get a project
const project = await jira.project('PROJ');

// Get project components
const components = await jira.project('PROJ').components();

// Get all projects
const projects = await jira.projects();

// Get a board and its sprints
const sprints = await jira.board(42).sprints({ state: 'active' });

// Get sprint issues
const sprintIssues = await jira.board(42).sprint(10).issues();

// Get current user
const me = await jira.currentUser();

Constructors

constructor

new JiraClient(options: JiraClientOptions): JiraClient
Parameters
- options: JiraClientOptions
  Connection and authentication options
Returns JiraClient
Throws
If apiUrl is not a valid URL
- Defined in src/JiraClient.ts:127

Properties

`Readonly`metrics

metrics: MetricsResource

Lightweight issue/user/project metrics derived from Jira Data Center REST and JQL.

Methods

board

board(boardId: number): BoardResource
Returns a BoardResource for a given board ID.

The returned resource can be awaited directly to fetch board info, or chained to access nested resources (sprints, issues, backlog).
Parameters
- boardId: number
  The numeric board ID
Returns BoardResource
A chainable board resource
Example
```
const board       = await jira.board(42);
const sprints     = await jira.board(42).sprints({ state: 'active' });
const backlog     = await jira.board(42).backlog({ maxResults: 50 });
const sprintIssues = await jira.board(42).sprint(10).issues();
```
- Defined in src/JiraClient.ts:488

boards

boards(params?: BoardsParams): Promise<PagedResponse<JiraBoard>>
Fetches all boards accessible to the authenticated user.

GET /rest/agile/latest/board
Parameters
- Optionalparams: BoardsParams
  Optional: startAt, maxResults, type, name, projectKeyOrId
Returns Promise<PagedResponse<JiraBoard>>
A paged response of boards
- Defined in src/JiraClient.ts:463

component

component(componentId: string): Promise<JiraComponent>
Fetches a single component by ID.

GET /rest/api/latest/component/{id}
Parameters
- componentId: string
  The component ID
Returns Promise<JiraComponent>
The component object
- Defined in src/JiraClient.ts:645

currentUser

currentUser(): Promise<JiraUser>
Fetches the currently authenticated user.

GET /rest/api/latest/myself

Returns Promise<JiraUser>
The authenticated user object
Example
```
const me = await jira.currentUser();
```
- Defined in src/JiraClient.ts:361

favouriteFilters

favouriteFilters(): Promise<JiraFilter[]>
Fetches the authenticated user's favourite filters.

GET /rest/api/latest/filter/favourite

Returns Promise<JiraFilter[]>
An array of filters
- Defined in src/JiraClient.ts:597

fields

fields(): Promise<JiraField[]>
Fetches all issue fields (system and custom).

GET /rest/api/latest/field

Returns Promise<JiraField[]>
An array of fields
- Defined in src/JiraClient.ts:575

filter

filter(filterId: string | number): Promise<JiraFilter>
Fetches a single filter by ID.

GET /rest/api/latest/filter/{id}
Parameters
- filterId: string | number
  The numeric filter ID
Returns Promise<JiraFilter>
The filter object
- Defined in src/JiraClient.ts:609

issue

issue(issueIdOrKey: string): IssueResource
Returns an IssueResource for a given issue key or ID, providing access to issue data and sub-resources (comments, changelog, transitions, etc.).

The returned resource can be awaited directly to fetch the issue, or chained to access nested resources.
Parameters
- issueIdOrKey: string
  The issue key (e.g., 'PROJ-42') or numeric ID
Returns IssueResource
A chainable issue resource
Example
```
const issue      = await jira.issue('PROJ-42');
const comments   = await jira.issue('PROJ-42').comments();
const changelog  = await jira.issue('PROJ-42').changelog();
const transitions = await jira.issue('PROJ-42').transitions();
```
- Defined in src/JiraClient.ts:237

issueLinkTypes

issueLinkTypes(): Promise<{ issueLinkTypes: JiraIssueLinkType[] }>
Fetches all issue link types.

GET /rest/api/latest/issueLinkType

Returns Promise<{ issueLinkTypes: JiraIssueLinkType[] }>
An object with the list of issue link types
- Defined in src/JiraClient.ts:586

issuetype

issuetype(id: string): Promise<JiraIssueType>
Fetches a single issue type by ID.

GET /rest/api/latest/issuetype/{id}
Parameters
- id: string
  The issue type ID
Returns Promise<JiraIssueType>
The issue type object
- Defined in src/JiraClient.ts:518

issuetypes

issuetypes(): Promise<JiraIssueType[]>
Fetches all issue types available to the authenticated user.

GET /rest/api/latest/issuetype

Returns Promise<JiraIssueType[]>
An array of issue types
- Defined in src/JiraClient.ts:506

on

on<K extends "request">(event: K, callback: JiraClientEvents[K]): this
Subscribes to a client event.
Type Parameters
- K extends "request"
Parameters
- event: K
- callback: JiraClientEvents[K]
Returns this
Example
```
jira.on('request', (event) => {
  console.log(`${event.method} ${event.url} — ${event.durationMs}ms`);
  if (event.error) console.error('Request failed:', event.error);
});
```
- Defined in src/JiraClient.ts:145

priorities

priorities(): Promise<JiraPriority[]>
Fetches all priorities.

GET /rest/api/latest/priority

Returns Promise<JiraPriority[]>
An array of priorities
- Defined in src/JiraClient.ts:529

priority

priority(id: string): Promise<JiraPriority>
Fetches a single priority by ID.

GET /rest/api/latest/priority/{id}
Parameters
- id: string
  The priority ID
Returns Promise<JiraPriority>
The priority object
- Defined in src/JiraClient.ts:541

project

project(projectIdOrKey: string): ProjectResource
Returns a ProjectResource for a given project key or ID.

The returned resource can be awaited directly to fetch project info, or chained to access nested resources.
Parameters
- projectIdOrKey: string
  The project key (e.g., 'PROJ') or numeric ID
Returns ProjectResource
A chainable project resource
Example
```
const project    = await jira.project('PROJ');
const components = await jira.project('PROJ').components();
const versions   = await jira.project('PROJ').versions();
const statuses   = await jira.project('PROJ').statuses();
```
- Defined in src/JiraClient.ts:306

projects

projects(params?: ProjectsParams): Promise<JiraProject[]>
Fetches all projects accessible to the authenticated user.

GET /rest/api/latest/project
Parameters
- Optionalparams: ProjectsParams
  Optional: expand, recent
Returns Promise<JiraProject[]>
An array of projects
- Defined in src/JiraClient.ts:282

search

search(params?: SearchParams): Promise<JiraSearchResponse>
Searches for issues using JQL.

GET /rest/api/latest/search
Parameters
- Optionalparams: SearchParams
  Optional: jql, startAt, maxResults, fields, expand, validateQuery
Returns Promise<JiraSearchResponse>
A search response containing matching issues
Example
```
const results = await jira.search({
  jql: 'project = PROJ AND status = Open ORDER BY created DESC',
  maxResults: 50,
  fields: 'summary,status,assignee,priority',
});
```
- Defined in src/JiraClient.ts:265

searchPost

searchPost(body: SearchPostParams): Promise<JiraSearchResponse>
Fetches issues using a POST search, which supports larger JQL queries and additional options such as specifying the fields list as an array.

POST /rest/api/latest/search
Parameters
- body: SearchPostParams
  Search request body
Returns Promise<JiraSearchResponse>
A search response containing matching issues
Example
```
const results = await jira.searchPost({
  jql: 'project = PROJ AND status = Open',
  maxResults: 100,
  fields: ['summary', 'status', 'assignee'],
});
```
- Defined in src/JiraClient.ts:631

status

status(idOrName: string): Promise<JiraStatus>
Fetches a single status by ID or name.

GET /rest/api/latest/status/{idOrName}
Parameters
- idOrName: string
  The status ID or name
Returns Promise<JiraStatus>
The status object
- Defined in src/JiraClient.ts:564

statuses

statuses(): Promise<JiraStatus[]>
Fetches all statuses.

GET /rest/api/latest/status

Returns Promise<JiraStatus[]>
An array of statuses
- Defined in src/JiraClient.ts:552

user

user(username: string): Promise<JiraUser>
Fetches a single user by username or key.

GET /rest/api/latest/user
Parameters
- username: string
  The username (login name) to look up
Returns Promise<JiraUser>
The user object
Example
```
const user = await jira.user('pilmee');
```
- Defined in src/JiraClient.ts:345

userActivity

userActivity(
usernames: string | string[],
params?: UserActivityParams,
): Promise<JiraSearchResponse>
Searches for issues updated by one or more users.

This uses Jira's updatedBy() JQL function, which is useful for deriving activity from Bitbucket slugs when they match Jira usernames.

POST /rest/api/latest/search
Parameters
- usernames: string | string[]
  A Jira username, user key, or Bitbucket slug that maps to one
- params: UserActivityParams = {}
  Optional date bounds, extra JQL filters, pagination, and fields
Returns Promise<JiraSearchResponse>
A search response containing issues touched by the user(s)
Example
```
const activity = await jira.userActivity(['pilmee', 'asmith'], {
  from: '-30d',
  fields: ['summary', 'updated', 'status'],
});
```
- Defined in src/JiraClient.ts:385

users

users(params?: UserSearchParams): Promise<JiraUser[]>
Searches for users.

GET /rest/api/latest/user/search
Parameters
- Optionalparams: UserSearchParams
  Optional: username, startAt, maxResults
Returns Promise<JiraUser[]>
An array of users
- Defined in src/JiraClient.ts:325

version

version(versionId: string): Promise<JiraVersion>
Fetches a single version by ID.

GET /rest/api/latest/version/{id}
Parameters
- versionId: string
  The version ID
Returns Promise<JiraVersion>
The version object
- Defined in src/JiraClient.ts:657

versionIssueCounts

versionIssueCounts(versionId: string): Promise<JiraVersionIssueCounts>
Fetches the related issue counts for a version.

GET /rest/api/latest/version/{id}/relatedIssueCounts
Parameters
- versionId: string
  The version ID
Returns Promise<JiraVersionIssueCounts>
Issue counts by type
- Defined in src/JiraClient.ts:669

versionUnresolvedIssueCount

versionUnresolvedIssueCount(
versionId: string,
): Promise<JiraVersionUnresolvedIssueCount>
Fetches the number of unresolved issues for a version.

GET /rest/api/latest/version/{id}/unresolvedIssueCount
Parameters
- versionId: string
  The version ID
Returns Promise<JiraVersionUnresolvedIssueCount>
The unresolved issue count
- Defined in src/JiraClient.ts:681

worklogsDeleted

worklogsDeleted(
params?: WorklogSinceParams,
): Promise<JiraWorklogDeletedResponse>
Fetches worklog IDs deleted after a cursor.

GET /rest/api/latest/worklog/deleted
Parameters
- Optionalparams: WorklogSinceParams
Returns Promise<JiraWorklogDeletedResponse>
- Defined in src/JiraClient.ts:434

worklogsList

worklogsList(ids: (string | number)[]): Promise<JiraWorklog[]>
Fetches worklogs by ID.

POST /rest/api/latest/worklog/list
Parameters
- ids: (string | number)[]
Returns Promise<JiraWorklog[]>
- Defined in src/JiraClient.ts:446

worklogsUpdated

worklogsUpdated(
params?: WorklogSinceParams,
): Promise<JiraWorklogUpdatedResponse>
Fetches worklog IDs updated after a cursor.

GET /rest/api/latest/worklog/updated

Use with worklogsList to hydrate changed worklogs for activity metrics.
Parameters
- Optionalparams: WorklogSinceParams
Returns Promise<JiraWorklogUpdatedResponse>
- Defined in src/JiraClient.ts:422

Class JiraClient

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns JiraClient

Throws

Properties

Readonlymetrics

Methods

board

Parameters

Returns BoardResource

Example

boards

Parameters

Returns Promise<PagedResponse<JiraBoard>>

component

Parameters

Returns Promise<JiraComponent>

currentUser

Returns Promise<JiraUser>

Example

favouriteFilters

Returns Promise<JiraFilter[]>

fields

Returns Promise<JiraField[]>

filter

Parameters

Returns Promise<JiraFilter>

issue

Parameters

Returns IssueResource

Example

issueLinkTypes

Returns Promise<{ issueLinkTypes: JiraIssueLinkType[] }>

issuetype

Parameters

Returns Promise<JiraIssueType>

issuetypes

Returns Promise<JiraIssueType[]>

on

Type Parameters

Parameters

Returns this

Example

priorities

Returns Promise<JiraPriority[]>

priority

Parameters

Returns Promise<JiraPriority>

project

Parameters

Returns ProjectResource

Example

projects

Parameters

Returns Promise<JiraProject[]>

search

Parameters

Returns Promise<JiraSearchResponse>

Example

searchPost

Parameters

Returns Promise<JiraSearchResponse>

Example

status

Parameters

Returns Promise<JiraStatus>

statuses

Returns Promise<JiraStatus[]>

user

Parameters

Returns Promise<JiraUser>

Example

userActivity

`Readonly`metrics