Function: transition()

transition(args: { lix: Lix; to: Pick<LixCommit, "id">; version?: Pick<LixVersion, "id">; }): Promise<{ author_account_ids?: null | string[]; change_ids?: null | string[]; change_set_id: string; id: string; meta_change_ids?: null | string[]; parent_commit_ids?: null | string[]; }>

Transitions a version to the target commit through the engine router.

Example

await transition({ lix, to: checkpoint })

Parameters

ParameterTypeDescription
args{ lix: Lix; to: Pick<LixCommit, "id">; version?: Pick<LixVersion, "id">; }-
args.lixLixLix instance that exposes lix.call.
args.toPick<LixCommit, "id">Target commit to transition towards.
args.version?Pick<LixVersion, "id">Optional version override; defaults to the active version.

Returns

Promise<{ author_account_ids?: null | string[]; change_ids?: null | string[]; change_set_id: string; id: string; meta_change_ids?: null | string[]; parent_commit_ids?: null | string[]; }>