@prismicio/client/dist/helpers/documentToLinkField.d.ts

The official JavaScript + TypeScript client library for Prismic

import { FilledContentRelationshipField } from "../types/value/contentRelationship.js";
import { PrismicDocument } from "../types/value/document.js";

//#region src/helpers/documentToLinkField.d.ts
type SetOptional<T, Keys extends keyof T> = Omit<T, Keys> & Partial<Pick<T, Keys>>;
/**
 * Converts a document into a link field, this is useful when crawling the API
 * for document links
 *
 * @typeParam TDocument - Specific interface of the provided document
 *
 * @param prismicDocument - A document coming from Prismic
 *
 * @returns The equivalent link field to use with `asLink()`
 *
 * @internal
 */
declare const documentToLinkField: <TDocument extends SetOptional<PrismicDocument, "slugs">>(prismicDocument: TDocument) => FilledContentRelationshipField<TDocument["type"], TDocument["lang"], TDocument["data"]>;
//#endregion
export { documentToLinkField };
//# sourceMappingURL=documentToLinkField.d.ts.map