refactor: add documentation to useBookmarks hook

This commit is contained in:
P. Reis 2024-12-11 15:38:38 -03:00
parent bff17c9fa0
commit 6a44582c9c
1 changed files with 6 additions and 0 deletions

View File

@ -4,6 +4,12 @@ import { useApi } from 'soapbox/hooks/useApi.ts';
import { useFeatures } from 'soapbox/hooks/useFeatures.ts'; import { useFeatures } from 'soapbox/hooks/useFeatures.ts';
import { statusSchema } from 'soapbox/schemas/status.ts'; import { statusSchema } from 'soapbox/schemas/status.ts';
/**
* Get all the statuses the user has bookmarked.
* https://docs.joinmastodon.org/methods/bookmarks/#get
* GET /api/v1/bookmarks
* TODO: add 'limit'
*/
function useBookmarks() { function useBookmarks() {
const api = useApi(); const api = useApi();
const features = useFeatures(); const features = useFeatures();