Class ProjectResource

Represents a Jira project resource with chainable async methods.

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

Example

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

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

// Get versions
const versions = await jiraClient.project('PROJ').versions();

// Get statuses per issue type
const statuses = await jiraClient.project('PROJ').statuses();

// Get project roles
const roles = await jiraClient.project('PROJ').roles();

Implements

Methods

components get role roles statuses then versions

Methods

components

get

role

roles

  • roles(): Promise<Record<string, string>>

    Fetches the roles defined in this project.

    GET /rest/api/latest/project/{projectIdOrKey}/role

    Returns Promise<Record<string, string>>

    A record mapping role names to their resource URLs

statuses

then

versions

  • versions(expand?: string): Promise<JiraVersion[]>

    Fetches the versions defined in this project.

    GET /rest/api/latest/project/{projectIdOrKey}/versions

    Parameters

    • Optionalexpand: string

      Optional: 'operations'

    Returns Promise<JiraVersion[]>

    An array of project versions

Settings

Member Visibility

On This Page

Methods