Class IssueResource

Represents a Jira issue resource with chainable async methods.

Implements PromiseLike<JiraIssue> so it can be awaited directly to fetch the issue, while also exposing sub-resource methods.

Example

// Await directly to get issue info
const issue = await jiraClient.issue('PROJ-42');

// Get issue with specific fields
const issue = await jiraClient.issue('PROJ-42').get({ fields: 'summary,status,assignee' });

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

// Get worklogs
const worklogs = await jiraClient.issue('PROJ-42').worklogs();

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

// Get available transitions
const transitions = await jiraClient.issue('PROJ-42').transitions();

// Get remote links
const remoteLinks = await jiraClient.issue('PROJ-42').remotelinks();

// Get votes
const votes = await jiraClient.issue('PROJ-42').votes();

// Get watchers
const watchers = await jiraClient.issue('PROJ-42').watchers();

Implements

PromiseLike<JiraIssue>

Index

Methods

changelog comment comments get remotelinks then transitions votes watchers worklog worklogs

Methods

changelog

changelog(_params?: ChangelogParams): Promise<JiraChangelogResponse>
Fetches the changelog for this issue.

Jira Data Center exposes changelog through GET /rest/api/latest/issue/{issueIdOrKey}?expand=changelog.
Parameters
- Optional_params: ChangelogParams
Returns Promise<JiraChangelogResponse>
A paged response of changelog entries
- Defined in src/resources/IssueResource.ts:160

comment

comment(commentId: string | number): Promise<JiraComment>
Fetches a single comment by ID.

GET /rest/api/latest/issue/{issueIdOrKey}/comment/{id}
Parameters
- commentId: string | number
  The numeric comment ID
Returns Promise<JiraComment>
The comment object
- Defined in src/resources/IssueResource.ts:120

comments

comments(params?: CommentsParams): Promise<JiraCommentResponse>
Fetches comments for this issue.

GET /rest/api/latest/issue/{issueIdOrKey}/comment
Parameters
- Optionalparams: CommentsParams
  Optional: startAt, maxResults, orderBy, expand
Returns Promise<JiraCommentResponse>
A paged response of comments
- Defined in src/resources/IssueResource.ts:105

get

get(params?: IssueParams): Promise<JiraIssue>
Fetches the issue.

GET /rest/api/latest/issue/{issueIdOrKey}
Parameters
- Optionalparams: IssueParams
  Optional: fields, expand, properties, updateHistory
Returns Promise<JiraIssue>
The issue object
- Defined in src/resources/IssueResource.ts:90

remotelinks

remotelinks(globalId?: string): Promise<JiraRemoteLink[]>
Fetches the remote links (external URLs) for this issue.

GET /rest/api/latest/issue/{issueIdOrKey}/remotelink
Parameters
- OptionalglobalId: string
  Optional global ID to filter by a specific remote link
Returns Promise<JiraRemoteLink[]>
An array of remote links
- Defined in src/resources/IssueResource.ts:191

then

then<TResult1 = JiraIssue, TResult2 = never>(
    onfulfilled?:
        | null
        | (value: JiraIssue) => TResult1 | PromiseLike<TResult1>,
    onrejected?: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>,
): PromiseLike<TResult1 | TResult2>
Allows the resource to be awaited directly, resolving with the issue. Delegates to IssueResource.get.
Type Parameters
- TResult1 = JiraIssue
- TResult2 = never
Parameters
- Optionalonfulfilled: null | (value: JiraIssue) => TResult1 | PromiseLike<TResult1>
- Optionalonrejected: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>
Returns PromiseLike<TResult1 | TResult2>
Implementation of PromiseLike.then
- Defined in src/resources/IssueResource.ts:75

transitions

transitions(
params?: TransitionsParams,
): Promise<{ transitions: JiraTransition[] }>
Fetches the available workflow transitions for this issue.

GET /rest/api/latest/issue/{issueIdOrKey}/transitions
Parameters
- Optionalparams: TransitionsParams
  Optional: transitionId, expand, skipRemoteOnlyCondition
Returns Promise<{ transitions: JiraTransition[] }>
An object containing the list of transitions
- Defined in src/resources/IssueResource.ts:176

votes

votes(): Promise<JiraVotes>
Fetches the vote information for this issue.

GET /rest/api/latest/issue/{issueIdOrKey}/votes

Returns Promise<JiraVotes>
The votes object
- Defined in src/resources/IssueResource.ts:205

watchers

watchers(): Promise<JiraWatchers>
Fetches the watcher information for this issue.

GET /rest/api/latest/issue/{issueIdOrKey}/watchers

Returns Promise<JiraWatchers>
The watchers object
- Defined in src/resources/IssueResource.ts:216

worklog

worklog(worklogId: string | number): Promise<JiraWorklog>
Fetches a single worklog by ID.

GET /rest/api/latest/issue/{issueIdOrKey}/worklog/{id}
Parameters
- worklogId: string | number
  The numeric worklog ID
Returns Promise<JiraWorklog>
The worklog object
- Defined in src/resources/IssueResource.ts:147

worklogs

worklogs(params?: WorklogsParams): Promise<JiraWorklogResponse>
Fetches worklogs for this issue.

GET /rest/api/latest/issue/{issueIdOrKey}/worklog
Parameters
- Optionalparams: WorklogsParams
  Optional: startAt, maxResults, expand
Returns Promise<JiraWorklogResponse>
A paged response of worklogs
- Defined in src/resources/IssueResource.ts:132

Class IssueResource

Example

Implements

Index

Methods

Methods

changelog

Parameters

Returns Promise<JiraChangelogResponse>

comment

Parameters

Returns Promise<JiraComment>

comments

Parameters

Returns Promise<JiraCommentResponse>

get

Parameters

Returns Promise<JiraIssue>

remotelinks

Parameters

Returns Promise<JiraRemoteLink[]>

then

Type Parameters

Parameters

Returns PromiseLike<TResult1 | TResult2>

transitions

Parameters

Returns Promise<{ transitions: JiraTransition[] }>

votes

Returns Promise<JiraVotes>

watchers

Returns Promise<JiraWatchers>

worklog

Parameters

Returns Promise<JiraWorklog>

worklogs

Parameters

Returns Promise<JiraWorklogResponse>

Settings

On This Page