Skip to content

Commit 6481388

Browse files
committed
docs: Add error and reload documentation
1 parent f1bc57a commit 6481388

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,9 @@ const { collections } = useCollections();
106106
Option | Type | Description
107107
--------------- | --------- | -------------
108108
`collections` | `array` | A list of collections available from the STAC catalog. Is `null` if collections have not been retrieved.
109-
`state` | `str` | The status of the request. `"IDLE"` before and after the request is sent or received. `"LOADING"` when the request is in progress.
109+
`state` | `str` | The status of the request. `"IDLE"` before and after the request is sent or received. `"LOADING"` when the request is in progress.
110110
`reload` | `function`| Callback function to trigger a reload of collections.
111+
`error` | [`Error`](#error) | Error information if the last request was unsuccessful. `undefined` if the last request was successful.
111112

112113
#### Example
113114

@@ -159,8 +160,10 @@ Option | Type | Description
159160

160161
Option | Type | Description
161162
--------------- | --------- | -------------
162-
`collection` | `object` | The collection matching the provided ID. Is `null` if collection has not been retrieved.
163-
`state` | `str` | The status of the request. `"IDLE"` before and after the request is sent or received. `"LOADING"` when the request is in progress.
163+
`collection` | `object` | The collection matching the provided ID. Is `null` if collection has not been retrieved.
164+
`state` | `str` | The status of the request. `"IDLE"` before and after the request is sent or received. `"LOADING"` when the request is in progress.
165+
`reload` | `function`| Callback function to trigger a reload of the collection.
166+
`error` | [`Error`](#error) | Error information if the last request was unsuccessful. `undefined` if the last request was successful.
164167

165168
#### Example
166169

@@ -212,6 +215,8 @@ Option | Type | Description
212215
--------------- | --------- | -------------
213216
`item` | `object` | The item matching the provided URL.
214217
`state` | `str` | The status of the request. `"IDLE"` before and after the request is sent or received. `"LOADING"` when the request is in progress.
218+
`reload` | `function`| Callback function to trigger a reload of the item.
219+
`error` | [`Error`](#error) | Error information if the last request was unsuccessful. `undefined` if the last request was successful.
215220

216221
#### Examples
217222

0 commit comments

Comments
 (0)