Core quickstart

VERSION 0.46.1 PUBLIC PREVIEW

The Core bundle provides essential shared functionality across the entire Maps SDK, including configuration management, common types, and utility functions.

Installing Dependencies

The Core bundle is automatically included when you install the Map or Services bundles:

1
# npm or Yarn - automatic peer dependency installation
2
npm install @tomtom-org/maps-sdk
3

4
# pnpm - enable auto-install-peers for easiest setup
5
echo "auto-install-peers=true" >> .npmrc
6
pnpm install @tomtom-org/maps-sdk

Peer dependencies (installed automatically with above commands):

lodash-es (v4) - Utility functions
turf (v7) - Geospatial analysis

For more details, see the Project setup guide .

Common Configuration

1
import { TomTomConfig } from '@tomtom-org/maps-sdk/core';
2

3
TomTomConfig.instance.put({
4
    apiKey: 'YOUR_API_KEY_HERE',
5
    language: 'en-GB'
6
});

1
TomTomConfig.instance.put({
2
    apiKey: 'YOUR_API_KEY_HERE',
3
    language: 'en-GB',           // Map labels language
4
    baseUrl: 'https://api.tomtom.com',  // API base URL
5
    timeout: 10000,              // Request timeout (ms)
6
    validateRequest: true        // Enable request validation
7
});

Using with Map Bundle

1
import { TomTomConfig } from '@tomtom-org/maps-sdk/core';
2
import { TomTomMap } from '@tomtom-org/maps-sdk/map';
3

4
TomTomConfig.instance.put({
5
    apiKey: 'YOUR_API_KEY_HERE'
6
});
7

8
const map = new TomTomMap({ mapLibre: { container: 'map' } });

Using with Services Bundle

1
import { TomTomConfig } from '@tomtom-org/maps-sdk/core';
2
import { search } from '@tomtom-org/maps-sdk/services';
3

4
TomTomConfig.instance.put({
5
    apiKey: 'YOUR_API_KEY_HERE'
6
});
7

8
const results = await search({
9
    query: 'restaurants',
10
    position: [4.9041, 52.3676]
11
});

Node.js Configuration

1
const { TomTomConfig } = require('@tomtom-org/maps-sdk/core');
2

3
TomTomConfig.instance.put({
4
    apiKey: process.env.TOMTOM_API_KEY,
5
    language: 'en-GB'
6
});

The Core bundle is automatically included when you install the Map or Services bundles - no separate installation needed.