Skip to main content

​
Overview

useFetchComment returns a function that fetches a single comment by ID. The response wraps the comment in a { comment } object to allow future expansion of the response shape.

​
Usage Example

import { useFetchComment } from "@sublay/react-js";

function DeepLinkComment({ commentId }: { commentId: string }) {
  const fetchComment = useFetchComment();

  const load = async () => {
    const { comment } = await fetchComment({
      commentId,
      include: ["user", "parent"],
    });
    console.log(comment);
  };

  return <button onClick={load}>Load Comment</button>;
}

​
Parameters

​
commentId
string
required
The ID of the comment to fetch.
​
include
string | string[]
Populate related data. Accepted values: "user", "entity", "space", "parent".
​
spaceReputationId
string
Optional. Resolves the embedded author’s reputation into a spaceReputation number. Accepts a space <uuid>, "none" (project-general bucket), or "context" (server-derived from the request context). Empty string, "general", and null are rejected. See Reputation.
​
spaceReputationDescendants
boolean
Optional. When true, spaceReputation is the subtree sum (the space plus all its descendants). Only honored when spaceReputationId is an explicit <uuid>.

​
Returns

​
comment
Comment
The fetched comment. When "parent" is included, comment.parentComment is populated. When spaceReputationId is set, the embedded author carries an added spaceReputation number. See Comment data model and Reputation.