Interface ParticleDefinitionUpgrade

One sequential JSON schema upgrade. The returned document must use fromVersion + 1.

interface ParticleDefinitionUpgrade {
    fromVersion: number;
    upgrade: (
        document: Readonly<ParticleDefinitionJSONRecord>,
    ) => Readonly<ParticleDefinitionJSONRecord>;
}

Index

Properties

fromVersion upgrade

Properties

`Readonly`fromVersion

fromVersion: number

Source version accepted by this step.

`Readonly`upgrade

upgrade: (
document: Readonly<ParticleDefinitionJSONRecord>,
) => Readonly<ParticleDefinitionJSONRecord>

Produce a plain JSON document whose version is exactly fromVersion + 1.