remotestorage-module-places/README.md

@remotestorage/module-places

This module allows you to manage saved places (Points of Interest) using the remoteStorage protocol.

Installation

pnpm add @remotestorage/module-places

Usage

import RemoteStorage from 'remotestoragejs';
import PlacesModule from '@remotestorage/module-places';

const remoteStorage = new RemoteStorage({
  modules: [PlacesModule],
});

// Access the module
const places = remoteStorage.places;

// Store a place
await places.store({
  title: 'My Favorite Coffee Shop',
  lat: 52.520008,
  lon: 13.404954,
});

// List all places
const allPlaces = await places.getPlaces();
console.log(allPlaces);

API Reference

Interfaces

• PlacesClient

Type Aliases

• Place