@vercel/sdk
Version:
<p align="center"> <a href="https://vercel.com"> <img src="https://assets.vercel.com/image/upload/v1588805858/repositories/vercel/logo.png" height="96"> <h3 align="center">Vercel</h3> </a> <p align="center">Develop. Preview. Ship.</p> </p>
20 lines • 1.65 kB
TypeScript
import { VercelCore } from "../core.js";
import { RequestOptions } from "../lib/sdks.js";
import { CancelDeploymentResponseBody } from "../models/canceldeploymentresponsebody.js";
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/httpclienterrors.js";
import { CancelDeploymentRequest } from "../models/locale.js";
import { ResponseValidationError } from "../models/responsevalidationerror.js";
import { SDKValidationError } from "../models/sdkvalidationerror.js";
import { VercelError } from "../models/vercelerror.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
* Cancel a deployment
*
* @remarks
* Cancels a deployment that is currently in progress, stopping the build before it completes. Use this to recover quickly from accidental deploys, wrong-branch pushes, or builds with known errors — without waiting for them to finish. Returns 400 if the deployment is no longer cancelable (already `READY`, `ERROR`, or `CANCELED`). Returns the updated deployment object with `readyState: 'CANCELED'` on success.
*
* If set, this operation will use {@link Security.bearerToken} from the global security.
*/
export declare function deploymentsCancelDeployment(client: VercelCore, request: CancelDeploymentRequest, options?: RequestOptions): APIPromise<Result<CancelDeploymentResponseBody, VercelError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=deploymentsCancelDeployment.d.ts.map