Release 4.1.0

[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)

Release 4.0.0

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)

Release v4.0.0-rc4

[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)

Release v4.0.0-rc3

[4.0.0-rc3] - 2022-08-11

Fixed

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

Release v4.0.0-rc2

[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.

Release v4.0.0-rc1

[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)

Release v3.7.2

Fixed

• Accept integer input to h3GetResolution (#113)

Release 3.7.1

[3.7.1] - 2021-03-10

Fixed

• Fixed bug in freeing geo polygon memory during polyfill (#104)

Release 3.7.0

[3.7.0] - 2020-10-15

Added

• Added bindings for new area and distance functions (#93):
  • cellArea
  • exactEdgeLength
  • pointDist
• All functions accepting H3 index input now also accept a [lowerBits, upperBits] tuple of 32-bit integers (#91)

Fixed

• Fixed type definition for UNITS (#94)

Changed

• Updated the core library to 3.7.1 (#93)

Release 3.6.4

[3.6.4] - 2020-06-02

Fixed

• Fixed h3IsValid returning true on certain edge cases (#81)
• Fix some polyfill edge cases (#86)

Changed

• Updated the core library to 3.6.3 - minor fixes for h3IsValid and compact (#81)
• Updated the core library to 3.6.4 - reinstate new polyfill algorithm (#86)