Class RuntimeHandle

[asyncDispose]

[dispose]

clearEventHandler

• clearEventHandler(): Promise<void>

  Stops event delivery and retires the previous handler.

  See mln_runtime_clear_event_handler in the C API reference.

  Returns Promise<void>

clearHttpHeaderTransform

• clearHttpHeaderTransform(): Promise<void>

  Clears the runtime-scoped outgoing HTTP header transform.

  See mln_runtime_clear_http_header_transform in the C API reference.

  Returns Promise<void>

clearResourceProvider

• clearResourceProvider(): Promise<void>

  Clears the runtime-scoped network resource provider.

  See mln_runtime_clear_resource_provider in the C API reference.

  Returns Promise<void>

clearResourceTransform

• clearResourceTransform(): Promise<void>

  Clears the runtime-scoped URL transform for network resources.

  See mln_runtime_clear_resource_transform in the C API reference.

  Returns Promise<void>

close

• close(): Promise<void>

  Starts release of a runtime after checking its children.

  See mln_runtime_release in the C API reference.

  Returns Promise<void>

createMap

• createMap(options?: MapOptions): Promise<MapHandle>

  Starts creation of a map on the runtime.

  See mln_runtime_create_map in the C API reference.

  Parameters

  • options: MapOptions = {}

  Returns Promise<MapHandle>

createOfflineRegion

• createOfflineRegion(
      definition: OfflineRegionDefinition,
      metadata: Uint8Array,
  ): Promise<OfflineRegionInfo>

  Starts creating an offline region.

  See mln_runtime_create_offline_region in the C API reference.

  Parameters

  • definition: OfflineRegionDefinition
  • metadata: Uint8Array

  Returns Promise<OfflineRegionInfo>

deleteOfflineRegion

• deleteOfflineRegion(regionId: bigint): Promise<void>

  Deletes an offline region.

  See mln_runtime_delete_offline_region in the C API reference.

  Parameters

  • regionId: bigint

  Returns Promise<void>

dispose

• dispose(): void

  Consumes a runtime handle without observing its asynchronous retirement.

  See mln_runtime_dispose in the C API reference.

  Returns void

getEventMask

• getEventMask(): bigint

  Reports which runtime-scoped event types this runtime queues.

  See mln_runtime_get_event_mask in the C API reference.

  Returns bigint

getOfflineRegion

• getOfflineRegion(regionId: bigint): Promise<OfflineRegionInfo | undefined>

  Starts getting one offline region by ID.

  See mln_runtime_get_offline_region in the C API reference.

  Parameters

  • regionId: bigint

  Returns Promise<OfflineRegionInfo | undefined>

getOfflineRegionStatus

• getOfflineRegionStatus(regionId: bigint): Promise<OfflineRegionStatus>

  Starts getting the current download status for an offline region.

  See mln_runtime_get_offline_region_status in the C API reference.

  Parameters

  • regionId: bigint

  Returns Promise<OfflineRegionStatus>

invalidateOfflineRegion

• invalidateOfflineRegion(regionId: bigint): Promise<void>

  Invalidates cached resources for an offline region.

  See mln_runtime_invalidate_offline_region in the C API reference.

  Parameters

  • regionId: bigint

  Returns Promise<void>

listOfflineRegions

• listOfflineRegions(): Promise<readonly OfflineRegionInfo[]>

  Starts listing the offline regions in the runtime database.

  See mln_runtime_list_offline_regions in the C API reference.

  Returns Promise<readonly OfflineRegionInfo[]>

mergeOfflineRegions

• mergeOfflineRegions(
      sideDatabasePath: string,
  ): Promise<readonly OfflineRegionInfo[]>

  Starts merging offline regions from another MapLibre offline database.

  See mln_runtime_merge_offline_regions in the C API reference.

  Parameters

  • sideDatabasePath: string

  Returns Promise<readonly OfflineRegionInfo[]>

runAmbientCacheOperation

• runAmbientCacheOperation(operation: AmbientCacheOperation): Promise<void>

  Starts a MapLibre ambient cache maintenance operation for this runtime.

  See mln_runtime_run_ambient_cache_operation in the C API reference.

  Parameters

  • operation: AmbientCacheOperation

  Returns Promise<void>

setEventHandler

• setEventHandler(handler?: RuntimeEventHandler): Promise<void>

  Selects how runtime and map events reach the host.

  See mln_runtime_set_event_handler in the C API reference.

  Parameters

  • Optionalhandler: RuntimeEventHandler

  Returns Promise<void>

setEventMask

• setEventMask(mask: bigint): void

  Selects which runtime-scoped event types this runtime queues.

  See mln_runtime_set_event_mask in the C API reference.

  Parameters

  • mask: bigint

  Returns void

setHttpHeaderTransform

• setHttpHeaderTransform(transform: HttpHeaderTransform): Promise<void>

  Registers or replaces the runtime-scoped outgoing HTTP header transform.

  See mln_runtime_set_http_header_transform in the C API reference.

  Parameters

  • transform: HttpHeaderTransform

  Returns Promise<void>

setMaximumAmbientCacheSize

• setMaximumAmbientCacheSize(size: bigint): Promise<void>

  Starts a change to this runtime's maximum ambient cache size.

  See mln_runtime_set_maximum_ambient_cache_size in the C API reference.

  Parameters

  • size: bigint

  Returns Promise<void>

setOfflineRegionDownloadState

• setOfflineRegionDownloadState(
      regionId: bigint,
      state: OfflineRegionDownloadState,
  ): Promise<void>

  Sets an offline region's native download state.

  See mln_runtime_set_offline_region_download_state in the C API reference.

  Parameters

  • regionId: bigint
  • state: OfflineRegionDownloadState

  Returns Promise<void>

setOfflineRegionObserved

• setOfflineRegionObserved(regionId: bigint, observed: boolean): Promise<void>

  Enables or disables runtime events for an offline region.

  See mln_runtime_set_offline_region_observed in the C API reference.

  Parameters

  • regionId: bigint
  • observed: boolean

  Returns Promise<void>

setResourceProvider

• setResourceProvider(provider: ResourceProvider): Promise<void>

  Registers or replaces a runtime-scoped network resource provider.

  See mln_runtime_set_resource_provider in the C API reference.

  Parameters

  • provider: ResourceProvider

  Returns Promise<void>

setResourceTransform

• setResourceTransform(transform: ResourceTransform): Promise<void>

  Registers or updates a runtime-scoped URL transform for network resources.

  See mln_runtime_set_resource_transform in the C API reference.

  Parameters

  • transform: ResourceTransform

  Returns Promise<void>

updateOfflineRegionMetadata

• updateOfflineRegionMetadata(
      regionId: bigint,
      metadata: Uint8Array,
  ): Promise<OfflineRegionInfo>

  Starts updating opaque binary metadata for an offline region.

  See mln_runtime_update_offline_region_metadata in the C API reference.

  Parameters

  • regionId: bigint
  • metadata: Uint8Array

  Returns Promise<OfflineRegionInfo>