Skip to main content

Minimum requirements

The Maps SDK for TypeScript enables the development of web-based mapping applications that run in modern browsers. Refer to the minimum requirements outlined below.

Development Environment​

Node.js and npm​

  • Node.js: Version 18.0 or higher
  • npm: Version 9.0 or higher (or equivalent package manager like yarn or pnpm)

To check your versions:

node --version
npm --version
  • TypeScript: Version 5.0 or higher

The SDK is fully typed and works seamlessly with TypeScript, but can also be used with plain JavaScript.

Module Bundler​

The SDK works with modern bundlers and build tools:

  • Vite 4.0+ (Recommended)
  • Webpack 5.0+
  • Rollup 3.0+
  • esbuild 0.17+
tip

We recommend using Vite for the best development experience with fast hot module replacement (HMR) and optimized builds.

Browser Support​

The SDK uses WebAssembly (WASM) and modern web APIs. The following browsers are supported:

Desktop Browsers​

  • Chrome: Version 90 or higher
  • Firefox: Version 89 or higher
  • Safari: Version 15 or higher
  • Edge: Version 90 or higher

Mobile Browsers​

  • iOS Safari: Version 15 or higher (iOS 15.0+)
  • Chrome for Android: Version 90 or higher
  • Firefox for Android: Version 89 or higher
note

The SDK requires WebAssembly support and modern JavaScript features (ES2020+). Make sure your target browsers support these features.

Dependencies​

The Maps SDK for TypeScript has minimal external dependencies. The package includes:

  • Core mapping engine (WebAssembly)
  • TypeScript type definitions
  • Asset files for map rendering

No additional mapping libraries or frameworks are required.

Performance Considerations​

  • RAM: 4GB minimum, 8GB recommended
  • Storage: At least 100MB free space for SDK and map assets
  • Network: Stable internet connection for initial map data download (offline capabilities available after download)

WebAssembly Performance​

The SDK is compiled to WebAssembly for near-native performance in the browser. However, performance may vary based on:

  • Device hardware capabilities
  • Browser implementation
  • Available system resources
  • Map complexity and zoom level
performance tip

For the best performance, ensure hardware acceleration is enabled in your browser settings. This significantly improves rendering performance for 3D maps and terrain visualization.

HTTPS Requirement​

For security reasons, many modern web APIs used by the SDK (including geolocation) require a secure context:

  • Development: localhost or http://127.0.0.1 (automatically considered secure)
  • Production: HTTPS is required
warning

The SDK will not function properly over plain HTTP in production environments. Always deploy your application using HTTPS.

Last updated on