Skip to main content

cancel

client.fileUpdateIntents.cancel(id: string, data?: CancelFileUpdateIntentRequest): Promise<unknown>

Cancels a file update intent.

Aborts an in-progress intent and releases any held resources or locks. Use this when an operation fails or needs to be terminated before completion.

Parameters​

ParameterTypeRequiredDescription
idstringYesThe unique identifier of the intent
dataCancelFileUpdateIntentRequestNoOptional cancellation parameters

Returns​

Promise<unknown> — A promise that resolves when the intent is cancelled

Example​

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.fileUpdateIntents.cancel('id');
console.log(result);