Class BoardResource

Represents a Jira Software board resource with chainable async methods.

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

Example

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

// Get sprints
const sprints = await jiraClient.board(42).sprints({ state: 'active' });

// Get board issues
const issues = await jiraClient.board(42).issues({ jql: 'status = Open' });

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

// Navigate to a sprint
const sprint = await jiraClient.board(42).sprint(10);
const sprintIssues = await jiraClient.board(42).sprint(10).issues();

Implements

Methods

backlog configuration get issues sprint sprints then

Methods

backlog

configuration

get

issues

sprint

  • sprint(sprintId: number): SprintResource

    Returns a SprintResource for a given sprint ID.

    The returned resource can be awaited directly to fetch sprint info, or chained to access sprint issues.

    Parameters

    • sprintId: number

      The numeric sprint ID

    Returns SprintResource

    A chainable sprint resource

    Example

    const sprint       = await jiraClient.board(42).sprint(10);
    const sprintIssues = await jiraClient.board(42).sprint(10).issues();

sprints

then

Settings

Member Visibility

On This Page

Methods