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

Type Alias RelatedPoisRequest

RelatedPoisRequest: "child" | "parent" | "all" | "off"

Which related Points of Interest search results include, based on hierarchical (parent/child) relationships.

Remarks

The modes are:

off: No related POIs included (default)
child: Include child POIs (e.g., terminals within an airport)
parent: Include parent POIs (e.g., airport containing a terminal)
all: Include both parent and child relationships

For example:

Airport (parent) ↔ Terminal (child)
Shopping Mall (parent) ↔ Individual Store (child)
University (parent) ↔ Department Building (child)

Example

const mode: RelatedPoisRequest = 'child';  // Include child POIs
const mode2: RelatedPoisRequest = 'all';   // Include all related