[4.5.0] - 2026-07-01

Added

• Added reverseDirectedEdge function

Changed

• Updated the core library to v4.5.0

Fixed

• Prevent oversized gridDisk and gridDiskDistances calls from corrupting subsequent calls.

[4.4.0] - 2025-08-21

Changed

• Updated the core library to v4.4.1 (#213)

Added

• Add isValidIndex, getIndexDigit, and constructCell from the core C library (#213)

[4.3.0] - 2025-08-21

Changed

• Updated the core library to v4.3.0 (#206)

Added

• Add gridRing function, to get all hexagons in a hollow hexagonal ring centered at some origin. (#206)

[4.2.1] - 2025-04-03

Changed

• Updated the core library to v4.2.1 (#202)

Added

• Add polygonToCellsExperimental function, supporting different containment modes. (#198)

[4.1.0] - 2023-01-19

Added

• Add cellToChildPos, childPosToCell, and cellToChildrenSize functions. (#170)

Changed

• Updated the core library to v4.1.0 (#170)

Fixed

• Patch libh3 bundles to check for typeof document != "undefined" before accessing document. This allows h3-js to be used in a Web Worker and React Native (#169)
• Fix H3Index type hints for cellToBoundary, cellArea, edgeLength (#171)

First production release for H3 v4 🎉 . As noted below, most function names have changed, but the H3 indexes have not, so while using v4 will require code changes it should be 100% backwards compatible with existing data. See the 4x migration guide for more information.

[4.0.0] - 2022-08-23

Breaking Changes

• Updated the core library to v4.0.0. This update renames the majority of the H3 functions. You can see a list of changed function names in the core library documentation. For the most part, upgrading to v4 for Javascript consumers should be a straightforward search & replace between the old names and the new. (#151, #144, #141, #139)
• Added more cases in which JS errors may be thrown. In H3 v3, many functions would fail silently with invalid input, returning null or similar signal values. In H3 v4, we will throw descriptive errors for most instances of bad input. (#139)

Changed

• Add Typescript typechecking, generate types with tsc (#153)

Fixed

• Fail package publish if there are library changes (#148)

Added

• Added legacy API wrapper with Typescript types (#146)

[4.0.0-rc4] - 2022-08-22

Breaking changes

• Updated the core library to v4.0.0-rc5. (#151)

Changed

• Add Typescript typechecking, generate types with tsc (#153)

[4.0.0-rc3] - 2022-08-11

Fixed

• Fail package publish if there are library changes (#148)

[4.0.0-rc2] - 2022-08-11

Added

• Added legacy API wrapper with Typescript types (#146)

Legacy API

H3 v4 renamed the majority of the functions in the library. To help ease migration from H3 v3 to H3 v4, we offer a legacy API wrapper at h3-js/legacy, which exports the v4 functions with the v3 names. Users are welcome to use the legacy API wrapper as a transitional support, but are encouraged to upgrade to the H3 v4 API as soon as possible.

Note that the legacy API is not 100% backwards compatible - it's a thin wrapper on top of the v4 functions, so in cases where behavior has changed, the v4 behavior will be used. In particular, many of the v4 functions will throw errors for invalid input, where v3 functions would return null.

[4.0.0-rc1] - 2022-07-28

First release candidate for H3 v4 🎉 . As noted below, most function names have changed, but the H3 indexes have not, so while using v4 will require code changes it should be 100% backwards compatible with existing data. See the 4x migration guide for more information.

Added

• Added vertex mode functions (#138)

Breaking Changes

• Updated the core library to v4.0.0-rc4. (#141)
• Updated the core library to v4.0.0-rc2. This update renames the majority of the H3 functions. You can see a list of changed function names in the core library documentation. For the most part, upgrading to v4 for Javascript consumers should be a straightforward search & replace between the old names and the new. (#139)
• Added more cases in which JS errors may be thrown. In H3 v3, many functions would fail silently with invalid input, returning null or similar signal values. In H3 v4, we will throw descriptive errors for most instances of bad input. (#139)