Interface ParticleDefinitionDeserializationOptions

Options used while upgrading and materializing a serialized definition.

interface ParticleDefinitionDeserializationOptions {
    compilationEnvironment?: Readonly<ParticleCompilationEnvironment>;
    resolveResource?: (
        kind: ParticleDefinitionResourceKind,
        id: string,
    ) => ParticleDefinitionResource;
    upgrades?: readonly ParticleDefinitionUpgrade[];
}

Index

Properties

compilationEnvironment? resolveResource? upgrades?

Properties

`Optional` `Readonly`compilationEnvironment

compilationEnvironment?: Readonly<ParticleCompilationEnvironment>

Optional compile target used for backend-specific definition validation.

`Optional` `Readonly`resolveResource

resolveResource?: (
kind: ParticleDefinitionResourceKind,
id: string,
) => ParticleDefinitionResource

Resolve stable asset identifiers without embedding runtime object IDs in the document.

`Optional` `Readonly`upgrades

upgrades?: readonly ParticleDefinitionUpgrade[]

Sequential application-owned upgrades for schema versions older than the engine version.