Class CustomField

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

Hierarchy (view full)

Implements

Constructors

constructor

Properties

availableOperations baseUrl canonicalName changedFields createFields createdAt description enabled entityType fieldType iconSetIdentifier id name position service updatedAt values

Accessors

baseUrl

Methods

_preSave create delete save update

Constructors

constructor

Properties

availableOperations

availableOperations: ResourceOperation[] = ...

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

baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/custom-fields'

canonicalName

canonicalName: string

Internal changedFields

changedFields: string[] = []

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

createFields

createFields: string[] = []

Fields that are used when creating a new resource

createdAt

createdAt: Date

description

description: string

enabled

enabled: boolean

entityType

entityType: string

fieldType

fieldType: string

iconSetIdentifier

iconSetIdentifier: string

id

id: string

name

name: string

position

position: number

service

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

updatedAt

updatedAt: Date

values

values: default[]

Accessors

Static baseUrl

  • get baseUrl(): string

  • The base URL for the resource to be used in API requests. This property must be overridden in the subclass.

    Returns string

    Throws

    • Throws an error if the property is not overridden in the subclass.

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>

create

  • create(): Promise<CustomField>

  • 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<CustomField>

    • 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

constructoravailableOperationsbaseUrlcanonicalNamechangedFieldscreateFieldscreatedAtdescriptionenabledentityTypefieldTypeiconSetIdentifieridnamepositionserviceupdatedAtvaluesbaseUrl_preSavecreatedeletesaveupdate