Skip to main content

Function: useCitations()

useCitations(uri, options): UseQueryResult<{ citations: object[]; counts: { citedByCount: number; influentialCitedByCount: number; referencesCount: number; }; cursor: string; hasMore: boolean; preprint: { title: string; uri: string; }; }, Error>

Defined in: web/lib/hooks/use-discovery.ts:183

Fetches citation network data for a preprint.

Parameters​

uri​

string

AT-URI of the preprint

options​

UseCitationsOptions = {}

Query options

Returns​

UseQueryResult<{ citations: object[]; counts: { citedByCount: number; influentialCitedByCount: number; referencesCount: number; }; cursor: string; hasMore: boolean; preprint: { title: string; uri: string; }; }, Error>

Query result with citations data

Remarks​

Returns both citation counts and the actual citation relationships between Chive-indexed preprints.

Example​

const { data } = useCitations('at://did:plc:abc/pub.chive.preprint/123');

if (data) {
  console.log(`Cited by ${data.counts.citedByCount} papers`);
}