Update docs
This commit is contained in:
@@ -10,6 +10,7 @@
|
||||
|
||||
## Type Aliases
|
||||
|
||||
- [List](type-aliases/List.md)
|
||||
- [Place](type-aliases/Place.md)
|
||||
|
||||
## Variables
|
||||
|
||||
@@ -6,6 +6,144 @@
|
||||
|
||||
# Interface: PlacesClient
|
||||
|
||||
## Properties
|
||||
|
||||
### lists
|
||||
|
||||
> **lists**: `object`
|
||||
|
||||
#### addPlace()
|
||||
|
||||
> **addPlace**(`listId`, `placeId`, `geohash`): `Promise`\<[`List`](../type-aliases/List.md)\>
|
||||
|
||||
Add a place to a list.
|
||||
|
||||
##### Parameters
|
||||
|
||||
###### listId
|
||||
|
||||
`string`
|
||||
|
||||
The slug ID of the list.
|
||||
|
||||
###### placeId
|
||||
|
||||
`string`
|
||||
|
||||
The ID of the place.
|
||||
|
||||
###### geohash
|
||||
|
||||
`string`
|
||||
|
||||
The geohash of the place.
|
||||
|
||||
##### Returns
|
||||
|
||||
`Promise`\<[`List`](../type-aliases/List.md)\>
|
||||
|
||||
#### create()
|
||||
|
||||
> **create**(`id`, `title`, `color?`): `Promise`\<[`List`](../type-aliases/List.md)\>
|
||||
|
||||
Create or update a list.
|
||||
|
||||
##### Parameters
|
||||
|
||||
###### id
|
||||
|
||||
`string`
|
||||
|
||||
The slug ID (e.g., "to-go").
|
||||
|
||||
###### title
|
||||
|
||||
`string`
|
||||
|
||||
Human readable title.
|
||||
|
||||
###### color?
|
||||
|
||||
`string`
|
||||
|
||||
Optional hex color code.
|
||||
|
||||
##### Returns
|
||||
|
||||
`Promise`\<[`List`](../type-aliases/List.md)\>
|
||||
|
||||
#### delete()
|
||||
|
||||
> **delete**(`id`): `Promise`\<`void`\>
|
||||
|
||||
Delete a list.
|
||||
|
||||
##### Parameters
|
||||
|
||||
###### id
|
||||
|
||||
`string`
|
||||
|
||||
The slug ID of the list.
|
||||
|
||||
##### Returns
|
||||
|
||||
`Promise`\<`void`\>
|
||||
|
||||
#### get()
|
||||
|
||||
> **get**(`id`): `Promise`\<[`List`](../type-aliases/List.md) \| `null`\>
|
||||
|
||||
Get a single list by ID (slug).
|
||||
|
||||
##### Parameters
|
||||
|
||||
###### id
|
||||
|
||||
`string`
|
||||
|
||||
The slug ID of the list.
|
||||
|
||||
##### Returns
|
||||
|
||||
`Promise`\<[`List`](../type-aliases/List.md) \| `null`\>
|
||||
|
||||
#### getAll()
|
||||
|
||||
> **getAll**(): `Promise`\<[`List`](../type-aliases/List.md)[]\>
|
||||
|
||||
Get all lists.
|
||||
|
||||
##### Returns
|
||||
|
||||
`Promise`\<[`List`](../type-aliases/List.md)[]\>
|
||||
|
||||
Array of List objects.
|
||||
|
||||
#### removePlace()
|
||||
|
||||
> **removePlace**(`listId`, `placeId`): `Promise`\<[`List`](../type-aliases/List.md)\>
|
||||
|
||||
Remove a place from a list.
|
||||
|
||||
##### Parameters
|
||||
|
||||
###### listId
|
||||
|
||||
`string`
|
||||
|
||||
The slug ID of the list.
|
||||
|
||||
###### placeId
|
||||
|
||||
`string`
|
||||
|
||||
The ID of the place.
|
||||
|
||||
##### Returns
|
||||
|
||||
`Promise`\<[`List`](../type-aliases/List.md)\>
|
||||
|
||||
## Methods
|
||||
|
||||
### get()
|
||||
|
||||
9
docs/type-aliases/List.md
Normal file
9
docs/type-aliases/List.md
Normal file
@@ -0,0 +1,9 @@
|
||||
[**@remotestorage/module-places**](../README.md)
|
||||
|
||||
***
|
||||
|
||||
[@remotestorage/module-places](../README.md) / List
|
||||
|
||||
# Type Alias: List
|
||||
|
||||
> **List** = `FromSchema`\<*typeof* `listSchema`\> & `object`
|
||||
Reference in New Issue
Block a user