Add README and API docs

This commit is contained in:
2026-01-26 19:20:54 +07:00
parent 713efb81b5
commit bc5eea7841
9 changed files with 510 additions and 3 deletions

View File

@@ -0,0 +1,27 @@
[**@remotestorage/module-places**](../README.md)
***
[@remotestorage/module-places](../README.md) / Place
# Type Alias: Place
> **Place** = `FromSchema`\<*typeof* `placeSchema`\> & `object`
Represents a Place object.
Core properties enforced by schema:
- `id`: Unique identifier (ULID)
- `title`: Name of the place
- `lat`: Latitude
- `lon`: Longitude
- `geohash`: Geohash for indexing
- `createdAt`: ISO date string
Optional properties:
- `description`: Text description
- `zoom`: Map zoom level
- `url`: Related URL
- `osmId`, `osmType`, `osmTags`: OpenStreetMap data
- `tags`: Array of string tags
- `updatedAt`: ISO date string