Skip to content

Commit 7c0bf4f

Browse files
committed
refactor: update ts doc
1 parent 049a408 commit 7c0bf4f

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

packages/hooks/src/hooks/API/useGetCoinPrices.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ const getCoinPrices = async (apiClient: SequenceAPIClient, tokens: Token[]) => {
6565
* }
6666
*
6767
* if (prices) {
68-
* console.log('ETH price:', prices[0].floorPrice.value)
68+
* console.log('ETH price:', prices[0].price.value)
6969
* }
7070
* ```
7171
*/

packages/hooks/src/hooks/API/useGetCollectiblePrices.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,11 @@ const getCollectiblePrices = async (apiClient: SequenceAPIClient, tokens: Token[
4545
*
4646
* @returns React Query result object containing:
4747
* - data: Array of token prices when available, each containing:
48-
* - floorPrice: The floor price for the collection
49-
* - buyPrice: Current market buy price
50-
* - sellPrice: Current market sell price
48+
* - price: The price for the collection
49+
* - price24hChange: The price change for the collection in the last 24 hours (if available)
50+
* - floorPrice: The floor price for the collection (if available)
51+
* - buyPrice: Current market buy price (if available)
52+
* - sellPrice: Current market sell price (if available)
5153
* - isLoading: Whether the initial request is in progress
5254
* - error: Any error that occurred
5355
* - isError: Whether an error occurred
@@ -68,9 +70,7 @@ const getCollectiblePrices = async (apiClient: SequenceAPIClient, tokens: Token[
6870
* }
6971
*
7072
* if (prices?.[0]) {
71-
* console.log('Floor price:', prices[0].floorPrice.value)
72-
* console.log('Buy price:', prices[0].buyPrice.value)
73-
* console.log('Sell price:', prices[0].sellPrice.value)
73+
* console.log('Price:', prices[0].price.value)
7474
* }
7575
* ```
7676
*/

0 commit comments

Comments
 (0)