Fetch many comments

Fetch a paginated list of comments with filters

Overview

useFetchManyComments returns a function that fetches a paginated list of comments. This is the underlying fetch function used by useEntityComments and useReplies. Use it directly when you need a custom comment list outside of those hooks.

Usage Example

import { useFetchManyComments } from "@sublay/react-js";
import { useState, useEffect } from "react";

function UserComments({ userId }: { userId: string }) {
  const fetchComments = useFetchManyComments();
  const [comments, setComments] = useState([]);

  useEffect(() => {
    fetchComments({ userId, page: 1, limit: 10 }).then((res) =>
      setComments(res.data)
    );
  }, [userId]);

  return (
    <ul>
      {comments.map((c) => <li key={c.id}>{c.content}</li>)}
    </ul>
  );
}

Parameters

page · number · required

Page number (1-indexed). Must be greater than 0.

entityId · string

Filter to comments on a specific entity.

userId · string

Filter to comments by a specific user.

parentId · string

Filter to replies of a specific parent comment.

sortBy · string

Sort order: "createdAt" or "top". "new"/"old" are deprecated aliases for "createdAt" (removed in v8). A sortDir ("asc"/"desc") controls "createdAt" direction.

limit · number

Results per page. Must be greater than 0.

sourceId · string

Filter to comments within a specific source.

include · string | string[]

Populate related data. Accepted values: "user", "entity", "space", "parent".

spaceReputationId · string

Resolves each row’s embedded author reputation into a spaceReputation number. Accepts a space <uuid>, "none" (project-general bucket), or "context" (server-derived per row from the request context). Empty string, "general", and null are rejected. See Reputation.

spaceReputationDescendants · boolean

When true, spaceReputation is the subtree sum (the space plus all its descendants). Only honored when spaceReputationId is an explicit <uuid>.

Returns

data · Comment[]

Comments for the current page. When spaceReputationId is set, each embedded author carries an added spaceReputation number. See Reputation.

pagination.hasMore · boolean

Whether there are more pages to load.