Apply suggestions from code review

Co-authored-by: Espen Hovlandsdal <espen@hovlandsdal.com>
sanity-io · Aug 19, 2024 · 3c8cba7 · 3c8cba7
1 parent 3bee7b4
commit 3c8cba7
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/packages/sanity/src/core/preview/createPathObserver.ts b/packages/sanity/src/core/preview/createPathObserver.ts
@@ -122,8 +122,9 @@ function normalizePaths(path: (FieldName | PreviewPath)[]): PreviewPath[] {
 /**
  * Creates a function that allows observing nested paths on a document.
  * If the path includes a reference, the reference will be "followed", allowing for selecting paths within the referenced document.
- * @param options - Options - Requires a function that can observe fields on a document
- * */
+ * @param options - Requires a function that can observe fields on a document
+ * @internal
+ */
 export function createPathObserver(options: {observeFields: ObserveFieldsFn}) {
   const {observeFields} = options
 

diff --git a/packages/sanity/src/core/preview/createPreviewObserver.ts b/packages/sanity/src/core/preview/createPreviewObserver.ts
@@ -28,7 +28,10 @@ function isReference(value: unknown): value is {_ref: string} {
   return isPlainObject(value)
 }
 
-// Takes a value and its type and prepares a snapshot for it that can be passed to a preview component
+/**
+ * Takes a value and its type and prepares a snapshot for it that can be passed to a preview component
+ * @internal
+ */
 export function createPreviewObserver(context: {
   observeDocumentTypeFromId: ObserveDocumentTypeFromIdFn
   observePaths: ObservePathsFn

diff --git a/packages/sanity/src/core/preview/observeFields.ts b/packages/sanity/src/core/preview/observeFields.ts
@@ -50,6 +50,7 @@ type Cache = {
  * Creates a function that allows observing individual fields on a document.
  * It will automatically debounce and batch requests, and maintain an in-memory cache of the latest field values
  * @param options - Options to use when creating the observer
+ * @internal
  */
 export function createObserveFields(options: {
   client: SanityClient