This is the documentation of version 1.0.0-rc.0. Go to the latest version, 1.0.0-rc.5.

Type Alias RoutingModuleSerializableConfig

RoutingModuleSerializableConfig: Omit<RoutingModuleConfig, "waypoints"> & {
    waypoints?: Omit<WaypointsConfig, "icon" | "label"> & {
        icon?: Omit<
            WaypointIconConfig,
            WaypointIndexType
            | "customIcons"
            | "mapping",
        > & { [R in WaypointIndexType]?: SerializablePinIconConfig } & {
            customIcons?: SerializableCustomImage[];
        };
        label?: SerializableFeatureLabelConfig<WaypointLabelConfig>;
    };
}

The part of a RoutingModuleConfig that survives JSON, for saving getConfig() and replaying it with applyConfig().

Remarks

It leaves out what JSON cannot carry, which a replay adds back in code:

waypoints.icon.mapping and waypoints.label.title as a function. A MapLibre expression title serialises.
Any image given as an HTMLImageElement, in waypoints.icon.customIcons and each waypoint role's image. See SerializableCustomImage.