Skip to main content

TypeScript Types Reference

The following types are part of the API of @remotion/vercel:

VercelSandbox​

import type {VercelSandbox} from '@remotion/vercel';
                  
(alias) type VercelSandbox = Sandbox & AsyncDisposable
import VercelSandbox

A Sandbox with AsyncDisposable support. Returned by createSandbox() and restoreSnapshot().

CreateSandboxOnProgress​

import type {CreateSandboxOnProgress} from '@remotion/vercel';
                       
(alias) type CreateSandboxOnProgress = (update: {
    progress: number;
    message: string;
}) => void
import CreateSandboxOnProgress
  • progress: A number from 0 to 1 indicating overall progress
  • message: A human-readable description of the current phase

RenderOnVercelProgress​

import type {RenderOnVercelProgress} from '@remotion/vercel';
                       
(alias) type RenderOnVercelProgress = {
    type: "opening-browser";
} | {
    type: "selecting-composition";
} | {
    type: "render-progress";
    progress: number;
} | {
    type: "uploading";
} | {
    type: "done";
    url: string;
    size: number;
}
import RenderOnVercelProgress
  • {type: 'opening-browser'}: The browser is being opened
  • {type: 'selecting-composition'}: The composition is being selected
  • {type: 'render-progress', progress: number}: Rendering is in progress (0 to 1)
  • {type: 'uploading'}: The rendered file is being uploaded
  • {type: 'done', url: string, size: number}: The render is complete