|
1 | | -# GeoParquet |
2 | | - |
3 | 1 |  |
4 | 2 |
|
5 | 3 | [](https://www.npmjs.com/package/geoparquet) |
|
9 | 7 |  |
10 | 8 | [](https://www.npmjs.com/package/geoparquet?activeTab=dependencies) |
11 | 9 |
|
| 10 | +# GeoParquet is DEPRECATED |
| 11 | + |
| 12 | +This GeoParquet JS library has been deprecated in favor of native support for GeoParquet in [hyparquet](https://github.com/hyparam/hyparquet). |
| 13 | + |
| 14 | +We recommend using hyparquet directly for reading GeoParquet files: |
| 15 | + |
| 16 | +```javascript |
| 17 | +const { asyncBufferFromUrl, parquetReadObjects } = await import('hyparquet') |
| 18 | + |
| 19 | +const file = await asyncBufferFromUrl({ url: 'example.parquet' }) |
| 20 | +const data = await parquetReadObjects({ file }) |
| 21 | +const geojson = { |
| 22 | + type: 'FeatureCollection', |
| 23 | + features: data.map(({ geometry, ...properties }) => ({ |
| 24 | + type: 'Feature', |
| 25 | + geometry, |
| 26 | + properties, |
| 27 | + })) |
| 28 | +} |
| 29 | +``` |
| 30 | + |
| 31 | +# GeoParquet |
| 32 | + |
12 | 33 | **GeoParquet** provides a pure JavaScript workflow to read and convert [GeoParquet](https://github.com/opengeospatial/geoparquet) files into [GeoJSON](https://datatracker.ietf.org/doc/html/rfc7946). Under the hood, it uses the [hyparquet](https://github.com/hyparam/hyparquet) library for efficient in-browser parquet parsing, enabling minimal overhead and fast loading. |
13 | 34 |
|
14 | 35 | ## Why GeoParquet? |
|
19 | 40 | - **Faster loading:** Pure JavaScript parsing of Parquet files in the browser, with tiny package size means fast page load times. |
20 | 41 | - **Seamless integration:** GeoParquet is based on well-established standards (GeoJSON, Parquet), ensuring broad compatibility and extensibility. |
21 | 42 |
|
22 | | -## Usage |
23 | | - |
24 | | -Convert a GeoParquet file to GeoJSON: |
25 | | - |
26 | | -```javascript |
27 | | -const { asyncBufferFromUrl, toGeoJson } = await import('geoparquet') |
28 | | - |
29 | | -const file = asyncBufferFromUrl({ url: 'example.parquet' }) |
30 | | -const geoJson = toGeoJson({ file }) |
31 | | -``` |
32 | | - |
33 | 43 | ## Demo |
34 | 44 |
|
35 | 45 | Check out the [live demo](https://hyparam.github.io/geoparquet/) to see GeoParquet in action. |
|
0 commit comments