Skip to main content

writeMigration

Write only complete migrations, retaining an exclusive backup for an in-place edit.

Import​

import { writeMigration } from '@bedrock-core/builder/migrate';

Signature​

function writeMigration(result: ProjectMigration, outputPath = result.configPath): Promise<{ path: string; backup?: string }>;

Parameters​

ParameterTypeDefaultDescription
resultProjectMigration—Values described by the parameter type
outputPathstringresult.configPathDestination config path; defaults to the previewed source config

Returns​

The written configuration path and an optional in-place backup path.

Notes​

Requires a ready preview. In-place writes retain a backup and reject changes to the original config after inspection.