Documentation

Author: pirelenito

packages/@react-facet/core/src/hooks/useFacetTransition.tsx

@@ -2,6 +2,10 @@ import { useTransition, useCallback } from 'react'
 import { Batch } from '../types'
 import { batchTransition } from '../scheduler'
 
+/**
+ * Hook that acts analogous to React's useTransition, ensuring that any React state change that happens as a
+ * result of a Facet update is handled within a React transition.
+ */
 export const useFacetTransition = (): [boolean, (fn: () => void) => void] => {
   const [isPending, reactStartTransition] = useTransition()
 

packages/@react-facet/core/src/startFacetTransition.tsx

@@ -1,6 +1,10 @@
 import { startTransition as reactStartTransition } from 'react'
 import { batchTransition } from './scheduler'
 
+/**
+ * API that acts analogous to React's startTransition, ensuring that any React state change that happens as a
+ * result of a Facet update is handled within a React transition.
+ */
 export const startFacetTransition = (fn: () => void) => {
   reactStartTransition(() => batchTransition(fn))
 }