For AI agents: a documentation index is available at /llms.txt. Markdown versions of all pages are available by appending .md to any URL.

Class ClientConfig

The configuration object definition

Index

Constructors

Properties

bufferToPixelData?: BufferToPixelDataFunction
tileCacheSize: number = 200

Number of tiles to keep in cache

Accessors

  • get apiHost(): string

    The host currently used for the MapTiler API requests (api.maptiler.com or api.maptiler.eu)

    Returns string

  • get apiKey(): string

    Get the MapTiler Cloud API key

    Returns string

  • set apiKey(k: string): void

    Set the MapTiler Cloud API key

    Parameters

    • k: string

    Returns void

  • get apiURL(): string

    The base URL currently used for the MapTiler API requests (https://api.maptiler.com/ or https://api.maptiler.eu/)

    Returns string

  • get useEuEndpoints(): boolean

    Whether the EU-based api.maptiler.eu host is currently in use instead of the default api.maptiler.com

    Returns boolean

  • set useEuEndpoints(value: boolean): void

    Switch between the default api.maptiler.com host and the EU-based api.maptiler.eu host. Set to false to switch back to the default.

    Parameters

    • value: boolean

    Returns void

Was this helpful?