Skip to content

Function: deleteComponent() ​

ts
function deleteComponent(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/server/api/projectComponents.ts:99

Delete a project component.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ id: string; moveIssuesTo?: string; }-
parameters.idstringThe component to delete.
parameters.moveIssuesTo?stringThe new component applied to issues whose 'id' component will be deleted. If this value is null, then the 'id' component is simply removed from the related isues.
options?RequestOptions-

Returns ​

Promise<void>