@sanity/desk-tool
Version:
Tool for managing all sorts of content in a structured manner
43 lines • 1.62 kB
TypeScript
export declare type ReferringDocuments = {
isLoading: boolean;
totalCount: number;
projectIds: string[];
datasetNames: string[];
hasUnknownDatasetNames: boolean;
internalReferences?: {
totalCount: number;
references: Array<{
_id: string;
_type: string;
}>;
};
crossDatasetReferences?: {
totalCount: number;
references: Array<{
/**
* The project ID of the document that is currently referencing the subject
* document. Unlike `documentId` and `datasetName`, this should always be
* defined.
*/
projectId: string;
/**
* The ID of the document that is currently referencing the subject
* document. This will be omitted if there is no access to the current
* project and dataset pair (e.g. if no `sanity-project-token` were
* configured)
*/
documentId?: string;
/**
* The dataset name that is currently referencing the subject document.
* This will be omitted if there is no access to the current project and
* dataset pair (e.g. if no `sanity-project-token` were configured)
*/
datasetName?: string;
}>;
};
};
export interface UseReferringDocumentsOptions {
externalPollInterval?: number;
}
export declare function useReferringDocuments(documentId: string, options?: UseReferringDocumentsOptions): ReferringDocuments;
//# sourceMappingURL=useReferringDocuments.d.ts.map