Skip to content
maplibre-yaml

EmitPayloadItemSchema

const EmitPayloadItemSchema: z.ZodType<{ else?: string; property?: string; str?: string; }>

Defined in: packages/core/src/schemas/layer.schema.ts:197

One entry in an emit payload: a declarative projection of a feature property (or a literal) into a named payload key.

Remarks

Section titled “Remarks”

This is the popup content item’s property-projection vocabulary (PopupContentItemSchema) narrowed to the subset that makes sense for a data payload rather than rendered markup:

  • property — the feature property to project.
  • else — the fallback when that property is missing.
  • str — a static literal value.

The display- and markup-only fields (format, href, src, alt, $html) are deliberately absent: a payload is data handed to a host callback, not HTML to render, so a consumer formats it however it likes. And unlike the popup item this schema is not .passthrough() — an executable, selector, or GLSL-shaped field is stripped on parse and flagged as an unknown key, which is the format law for emit: it names an event and projects properties, and no field on it may carry code.