Add README and API docs
This commit is contained in:
27
docs/type-aliases/Place.md
Normal file
27
docs/type-aliases/Place.md
Normal 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
|
||||
Reference in New Issue
Block a user