API / @aionbuilders/nabu

RegionsConfig

Type Stability: stable

Related guide: Regions →

Definition

TypeScript
import type { RegionsConfig } from '@aionbuilders/nabu';
TypeScript
interface RegionsConfig {
  defaultType: string;
  maxLevel: number;
  types: Map<string, RegionTypeDef>;
}

Properties

Properties of RegionsConfig
PropertyTypeDescription
defaultTypestring

the type insertRegion uses when none is given: the declared type of the lowest level

maxLevelnumber

the deepest declared level (the level given to a marker whose type is not declared)

typesMap<string, RegionTypeDef>

in declaration order

Source: src/lib/blocks/region/types.js:41