Skip to main content

Overview

Returns a function that fetches the paginated list of users the currently authenticated user follows. Each entry includes the follow record ID, the followed user’s profile, and the timestamp. For fetching another user’s following list, see useFetchFollowingByUserId.

Usage Example

Parameters

The hook returns a function. That function accepts:
page
number
Page number to fetch. Defaults to 1.
limit
number
Number of results per page. Defaults to 20.
query
string
Optional search term. Filters the list to users whose username or name contains this text (case-insensitive). When omitted, no filtering is applied.
searchFields
string
Restricts which field query matches against — username or name. When omitted, query matches either field.

Returns

Returns a PaginatedResponse containing an array of following entries:
data
FollowingWithFollowInfo[]
Array of following entries.
pagination
object
Pagination metadata including currentPage, totalPages, totalCount, hasNextPage, and hasPreviousPage.