Class IterationsService

Hierarchy

Constructors

  • Service classes are not intended to be instantiated directly. Instead, use the Client class to create instances of services.

    Parameters

    • init: {
          headers: Record<string, string>;
      }
      • headers: Record<string, string>

    Returns IterationsService

Properties

availableOperations: ServiceOperation[] = ...
baseUrl: string = 'https://api.app.shortcut.com/api/v3/iterations'
headers: Record<string, string>
instances: Record<string, Iteration> = {}

Methods

  • Search for resources using the Shortcut Syntax

    Parameters

    • query: string

      The search query to use

    • Optional next: string

      The next page token to use for pagination

    Returns Promise<SearchResponse<Iteration, IterationInterface>>

    Example

    const client = new Client()
    const epics = client.epic.search('My epic')
    const stories = client.story.search('team:platform')
    const objectives = client.objective.search({team_id: 123})
    const iterations = client.iteration.search('team:platform')

    Throws

    Error if the HTTP status code is 400 or greater