🎥 Make videos programmatically with React
import type {DelayRenderScope} from './delay-render.js';
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/stack
export const getErrorStackWithMessage = (error: Error): string => {
const stack = error.stack ?? '';
return stack.startsWith('Error:') ? stack : `${error.message}\n${stack}`;
};
const isErrorLike = (err: unknown): boolean => {
if (err instanceof Error) {
return true;
}
if (err === null) {
return false;
}
if (typeof err !== 'object') {
return false;
}
if (!('stack' in err)) {
return false;
}
// eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
// @ts-ignore we just asserted
if (typeof err.stack !== 'string') {
return false;
}
if (!('message' in err)) {
return false;
}
// eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
// @ts-ignore we just asserted
if (typeof err.message !== 'string') {
return false;
}
return true;
};
/**
* Internal function that accepts scope as parameter.
* This allows useDelayRender to control its own scope source.
* @private
*/
export function cancelRenderInternal(
scope: DelayRenderScope | undefined,
err: unknown,
): never {
let error: Error;
if (isErrorLike(err)) {
error = err as Error;
if (!error.stack) {
error.stack = new Error(error.message).stack;
}
} else if (typeof err === 'string') {
error = Error(err);
} else {
error = Error('Rendering was cancelled');
}
if (scope) {
// Server rendering reads the stack across Puppeteer. Browser rendering can
// keep the original Error in this realm, including its cause chain.
scope.remotion_cancelledErrorObject = error;
scope.remotion_cancelledError = getErrorStackWithMessage(error);
}
throw error;
}
/*
* @description When you invoke this function, Remotion will stop rendering all the frames without any retries.
* @see [Documentation](https://remotion.dev/docs/cancel-render)
*/
export function cancelRender(err: unknown): never {
return cancelRenderInternal(
typeof window !== 'undefined' ? window : undefined,
err,
);
}