Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
e019cb01ba
|
|||
|
eb2878ec6a
|
|||
|
602cc44ae2
|
|||
|
b9615d7b97
|
|||
|
63e644c85a
|
|||
|
d8e893a5f0
|
10
README.md
10
README.md
@@ -1,7 +1,13 @@
|
|||||||
# @remotestorage/module-places
|
# @remotestorage/module-places
|
||||||
|
|
||||||
|
[](https://www.npmjs.com/package/@remotestorage/module-places)
|
||||||
|
|
||||||
This module allows you to manage saved places (Points of Interest) using the [remoteStorage](https://remotestorage.io/) protocol.
|
This module allows you to manage saved places (Points of Interest) using the [remoteStorage](https://remotestorage.io/) protocol.
|
||||||
|
|
||||||
|
It leverages [Geohashes](https://www.geohash.es/) to organize data, enabling efficient retrieval of places within specific geographic areas. This structure is particularly optimized for map applications that need to load data only for the visible viewport.
|
||||||
|
|
||||||
|
For a demo application, as well as source code using this module, check out [Marco](https://marco.kosmos.org).
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -31,6 +37,10 @@ await places.store({
|
|||||||
// List all places
|
// List all places
|
||||||
const allPlaces = await places.getPlaces();
|
const allPlaces = await places.getPlaces();
|
||||||
console.log(allPlaces);
|
console.log(allPlaces);
|
||||||
|
|
||||||
|
// List places for specific geohash prefixes (e.g. for a map view)
|
||||||
|
const areaPlaces = await places.getPlaces(['u33d', 'u33e']);
|
||||||
|
console.log(areaPlaces);
|
||||||
```
|
```
|
||||||
|
|
||||||
## API Reference
|
## API Reference
|
||||||
|
|||||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "@remotestorage/module-places",
|
"name": "@remotestorage/module-places",
|
||||||
"version": "1.1.1",
|
"version": "1.1.3",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "@remotestorage/module-places",
|
"name": "@remotestorage/module-places",
|
||||||
"version": "1.1.1",
|
"version": "1.1.3",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"latlon-geohash": "^2.0.0",
|
"latlon-geohash": "^2.0.0",
|
||||||
|
|||||||
@@ -1,12 +1,16 @@
|
|||||||
{
|
{
|
||||||
"name": "@remotestorage/module-places",
|
"name": "@remotestorage/module-places",
|
||||||
"version": "1.1.1",
|
"version": "1.1.3",
|
||||||
"description": "Manage favorite/saved places",
|
"description": "Manage favorite/saved places",
|
||||||
"homepage": "https://gitea.kosmos.org/raucao/remotestorage-module-places#remotestoragemodule-places",
|
"homepage": "https://gitea.kosmos.org/raucao/remotestorage-module-places#remotestoragemodule-places",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://gitea.kosmos.org/raucao/remotestorage-module-places.git"
|
"url": "git+https://gitea.kosmos.org/raucao/remotestorage-module-places.git"
|
||||||
},
|
},
|
||||||
|
"keywords": [
|
||||||
|
"remotestorage",
|
||||||
|
"remotestorage-module"
|
||||||
|
],
|
||||||
"main": "dist/places.js",
|
"main": "dist/places.js",
|
||||||
"types": "dist/places.d.ts",
|
"types": "dist/places.d.ts",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
|
|||||||
Reference in New Issue
Block a user