Function applySourceDocuments

applySourceDocuments<Result = unknown>(
    result: Result,
    resultSourceMap: ContentSourceMap | undefined,
    getCachedDocument: (
        sourceDocument:
            | ContentSourceMapDocument
            | ContentSourceMapRemoteDocument,
    ) => | Partial<SanityDocument> & Required<
        Pick<SanityDocument, "_id" | "_type">,
    >
    | null
    | undefined,
    updateFn: ApplySourceDocumentsUpdateFunction,
    perspective:
        | "previewDrafts"
        | "published"
        | "drafts"
        | StackablePerspective[],
): Result
Alpha
Optimistically applies source documents to a result, using the content source map to trace fields. Can be used to apply mutations to documents being edited in a Studio, or any mutation on Content Lake, to a result with extremely low latency.
Type Parameters
- Result = unknown
Parameters
- result: Result
- resultSourceMap: ContentSourceMap | undefined
- getCachedDocument: (
      sourceDocument:
          | ContentSourceMapDocument
          | ContentSourceMapRemoteDocument,
  ) => | Partial<SanityDocument> & Required<
      Pick<SanityDocument, "_id" | "_type">,
  >
  | null
  | undefined
- updateFn: ApplySourceDocumentsUpdateFunction
- perspective: "previewDrafts" | "published" | "drafts" | StackablePerspective[]
Returns Result
- Defined in src/csm/applySourceDocuments.ts:21