Class Epic

Base class for all Shortcut resources. Provides methods for creating, updating, and deleting resources.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

appUrl archived associatedGroups availableOperations changedFields completed completedAt completedAtOverride createFields deadline description entityType epicStateId externalId followerIds groupIds id labelIds labels memberMentionIds mentionIds milestoneId name objectiveIds ownerIds plannedStartDate position productboardId productboardName productboardPluginId productboardUrl projectIds requestedById service started startedAt startedAtOverride stats storiesWithoutProjects updatedAt baseUrl

Accessors

followers objectives owners teams

Methods

_preSave addComment comment create delete save update

Constructors

constructor

Properties

appUrl

appUrl: string

archived

archived: boolean

associatedGroups

associatedGroups: []

availableOperations

availableOperations: ResourceOperation[] = []

The available operations for the resource, any not in this list will raise an error when called

Internal changedFields

changedFields: string[] = []

Fields that have been changed, used to determine what to update. It is not recommended to access this property directly.

completed

completed: boolean

completedAt

completedAt: null | string

completedAtOverride

completedAtOverride: null | string

createFields

createFields: string[] = ...

Fields that are used when creating a new resource

deadline

deadline: null | string

description

description: string

entityType

entityType: string

epicStateId

epicStateId: number

externalId

externalId: null | string

followerIds

followerIds: string[]

groupIds

groupIds: string[]

id

id: number

labelIds

labelIds: number[]

labels

labels: []

memberMentionIds

memberMentionIds: string[]

mentionIds

mentionIds: string[]

milestoneId

milestoneId: null | number

name

name: string

objectiveIds

objectiveIds: number[]

ownerIds

ownerIds: string[]

plannedStartDate

plannedStartDate: null | string

position

position: number

productboardId

productboardId: null | string

productboardName

productboardName: null | string

productboardPluginId

productboardPluginId: null | string

productboardUrl

productboardUrl: null | string

projectIds

projectIds: number[]

requestedById

requestedById: string

service

service: BaseService<BaseResource<default>, default> | BaseSearchableService<BaseResource<default>, default>

started

started: boolean

startedAt

startedAt: null | string

startedAtOverride

startedAtOverride: null | string

stats

stats: object

storiesWithoutProjects

storiesWithoutProjects: number

updatedAt

updatedAt: null | string

Static baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/epics'

Accessors

followers

objectives

owners

teams

  • get teams(): Promise<Team[]>

  • Get the teams assigned to the story, labelled as "Group" in the Shortcut API

    Returns Promise<Team[]>

Methods

Protected _preSave

  • _preSave(): Promise<void>
  • Protected

    This method can be overridden by derived classes to perform any necessary operations before saving the resource

    Returns Promise<void>

addComment

comment

  • comment(comment): Promise<void | ThreadedCommentInterface>

  • Add a comment to the epic authored by the user associated with the API key currently in use

    Parameters

    • comment: string

    Returns Promise<void | ThreadedCommentInterface>

    Example

    const epic = new Epic({id: 123})
    epic.comment('This is a comment').then((comment) => {
       console.log(comment)
    })

create

  • create(): Promise<Epic>

  • Create a new instance of the resource, using the current object's properties. Use the xCreateData interface to determine which fields are available for creation.

    Returns Promise<Epic>

    • A Promise that resolves with the newly created instance.

    Throws

    • Throws an error if the HTTP request fails.

delete

  • delete(): Promise<void>

  • Delete the current instance of the resource.

    Returns Promise<void>

    • A Promise that resolves when the resource has been deleted.

    Throws

    • Throws an error if the HTTP request fails.

save

  • save(): Promise<void>

  • Save the current instance of the resource. If the resource already exists (has an ID), it will be updated. Otherwise, it will be created using the fields createFields.

    Returns Promise<void>

update

  • update(): Promise<void>

  • Update the current instance of the resource with the changed fields.

    Returns Promise<void>

    • A Promise that resolves when the resource has been updated.

    Throws

    • Throws an error if the HTTP request fails.

Settings

Member Visibility

Theme

On This Page

constructorappUrlarchivedassociatedGroupsavailableOperationschangedFieldscompletedcompletedAtcompletedAtOverridecreateFieldsdeadlinedescriptionentityTypeepicStateIdexternalIdfollowerIdsgroupIdsidlabelIdslabelsmemberMentionIdsmentionIdsmilestoneIdnameobjectiveIdsownerIdsplannedStartDatepositionproductboardIdproductboardNameproductboardPluginIdproductboardUrlprojectIdsrequestedByIdservicestartedstartedAtstartedAtOverridestatsstoriesWithoutProjectsupdatedAtbaseUrlfollowersobjectivesownersteams_preSaveaddCommentcommentcreatedeletesaveupdate