Class LabelsService

Hierarchy (view full)

BaseService<Label, LabelInterface>
- LabelsService

Index

Constructors

Properties

availableOperations baseUrl headers instances

Methods

factory get getByName getMany list

Constructors

constructor

new LabelsService(init): LabelsService
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 LabelsService
Inherited from BaseService.constructor
- Defined in base-service.ts:26

Properties

availableOperations

availableOperations: ServiceOperation[] = ...

Lists out the available operations for the resource, calling methods not in this list will result in an error

baseUrl

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

headers

headers: Record<string, string>

`Protected` instances

instances: Record<string, Label> = {}

Methods

`Protected` factory

factory(data): Label
Parameters
- data: object
Returns Label
Overrides BaseService.factory
- Defined in labels/labels-service.ts:8

get

get(id): Promise<Label>
Parameters
- id: string | number
Returns Promise<Label>
Inherited from BaseService.get
- Defined in base-service.ts:30

getByName

getByName(name): Promise<null | Label>
A convenience method to get a label by its name
Parameters
- name: string
  The name of the label to get. Note that the search is case-sensitive.
Returns Promise<null | Label>
The label with the given name, or null if no label is found
- Defined in labels/labels-service.ts:16

getMany

getMany(ids): Promise<Label[]>
Parameters
- ids: string[] | number[]
Returns Promise<Label[]>
Inherited from BaseService.getMany
- Defined in base-service.ts:49

list

list(): Promise<Label[]>
Returns Promise<Label[]>
Inherited from BaseService.list
- Defined in base-service.ts:53