getBranch

Beta

getBranch

Get a project branch by ID.

framer.getBranch(branchId: BranchId): Promise<Branch | null

Parameters

  • branchId: BranchId – The ID of the branch to retrieve. Use "main" for the main branch.

Returns

  • Promise<Branch | null> – The branch, or null when branching is unavailable for the project, such as when the project is using an older version that does not support branching or the project does not have access to branching.