Class SprintResource

Represents a Jira Software sprint resource.

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

Example

// Await directly to get sprint info
const sprint = await jiraClient.board(42).sprint(10);

// Get sprint issues
const issues = await jiraClient.board(42).sprint(10).issues({ maxResults: 50 });

Implements

PromiseLike<JiraSprint>

Index

Methods

get issues then

Methods

get

get(): Promise<JiraSprint>
Fetches the sprint details.

GET /rest/agile/latest/sprint/{sprintId}

Returns Promise<JiraSprint>
The sprint object
- Defined in src/resources/SprintResource.ts:51

issues

issues(params?: BoardIssuesParams): Promise<JiraSearchResponse>
Fetches issues in this sprint.

GET /rest/agile/latest/sprint/{sprintId}/issue
Parameters
- Optionalparams: BoardIssuesParams
  Optional: startAt, maxResults, jql, fields, expand
Returns Promise<JiraSearchResponse>
A search response containing the sprint's issues
- Defined in src/resources/SprintResource.ts:63

then

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

Class SprintResource

Example

Implements

Index

Methods

Methods

get

Returns Promise<JiraSprint>

issues

Parameters

Returns Promise<JiraSearchResponse>

then

Type Parameters

Parameters

Returns PromiseLike<TResult1 | TResult2>

Settings

On This Page