Skip to content

The HERE Data SDK for TypeScript is a modern, lightweight and modular SDK for the HERE platform

License

Notifications You must be signed in to change notification settings

heremaps/here-data-sdk-typescript

Repository files navigation

HERE Data SDK for TypeScript

HERE Data SDK for TypeScript is a TypeScript client for the HERE platform.

Use the SDK

To learn how to install and use the Data SDK, see the Getting Started Guide and Developer Guide.

Health check

Build and test

Master Node version Status
Build/Test/Bundling/Typedoc Node 18.17.1 (LTS) Build Status

Test coverage

Platform Status
Linux Linux code coverage

Backward compatibility

We try to develop and maintain our API in a way that preserves its compatibility with the existing applications. Changes in Data SDK for TypeScript are greatly influenced by the Data API development. Data API introduces breaking changes 6 months in advance. Therefore, you may need to migrate to a new version of Data SDK for TypeScript every half a year.

For more information on Data API, see its Developer Guide and API Reference.

When new API is introduced in Data SDK for TypeScript, the old one is not deleted straight away. The standard API deprecation time is 6 months. It gives you time to switch to new code. However, we do not provide API backward compatibility.

Learn more about deprecated methods, functions, and parameters in the Data SDK for TypeScript API Reference and changelog.

For more information on Data SDK for TypeScript, see our Getting Started Guide and Developer Guide.

About this repository

The Data SDK repository is a monorepo that contains the core components of the platform SDK organized in the NPM workspace.

All components can be used stand-alone and are in the @here subdirectory.

LICENSE

Copyright (C) 2019-2024 HERE Europe B.V.

For license details, see the LICENSE file in the root of this project.