Skip to main content

TypeAlias.ImportMappingDestination

type ImportMappingDestination = {
description?: string;
example?: unknown;
field: string;
required: boolean;
};

A destination as described to the mapping-suggestion model: the dot-path, whether the import requires it, and — when the passport schema documents them — the field's own description and example. Those two are the semantic context a bare dot-path cannot carry (what modelNumber means next to itemNumber, or that a URL field expects an absolute URL).

Properties

PropertyType
description?string
example?unknown
fieldstring
requiredboolean