Delete a component
delete_componentDelete a custom TypeScript component, or a shared module with name shared/, from the project. Refused while the film places the component (its Asset ID is in main.film): remove its and its clips with patch_film first. Refused when another component imports it, with the build output that names that component. branchId null (or left out) means the current version; a version id from list_branches deletes it on that version without switching the editor to it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Component class name, a JavaScript identifier, or shared/<name> for a shared module that components import as ./shared/<name>. | |
| branchId | Yes | Version id from list_branches to write to, without switching the editor to it. null, or leaving it out, means the current version. | |
| projectId | Yes | The project this call runs on without changing the open project. null (or leaving it out) uses the open project. wait_for_jobs takes the projectId of the calls that started the jobs. |