deploy

Beta

deploy

Deploy a published version to custom domains.

framer.deploy(deploymentId: string, domains?: string[]): Promise<Hostname[]

If domains is omitted, this deploys to the project's configured custom domain. If the project has no custom domain, nothing is deployed and an empty array is returned.

Passing a branch deployment points the target domains at that branch's content. Only do this when intentionally promoting branch content.

Check framer.isAllowedTo("deploy") before calling this method.

Parameters

  • deploymentId: string – The deployment to deploy.

  • domains: string[] (optional) – The domains to deploy to. Defaults to the project's configured custom domain.

Returns

  • Promise<Hostname[]> – The hostnames the deployment was deployed to.