Documentation: Add AutosaveMonitor component JSDoc and populate `RE…

…ADME` with auto-gen docs (#60882) Co-authored-by: colorful-tones <[email protected]> Co-authored-by: Mamaduka <[email protected]>
WordPress · Apr 19, 2024 · 42947ce · 42947ce
1 parent 33aa0a7
commit 42947ce
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/packages/editor/README.md b/packages/editor/README.md
@@ -128,7 +128,13 @@ Example:
 
 ### AutosaveMonitor
 
-Undocumented declaration.
+AutosaveMonitor component. Monitors the changes made to the edited post and triggers autosave if necessary.
+
+_Usage_
+
+```jsx
+<AutosaveMonitor interval={ 30000 } />
+```
 
 ### BlockAlignmentToolbar
 

diff --git a/packages/editor/src/components/autosave-monitor/index.js b/packages/editor/src/components/autosave-monitor/index.js
@@ -91,6 +91,15 @@ export class AutosaveMonitor extends Component {
 	}
 }
 
+/**
+ * AutosaveMonitor component.
+ * Monitors the changes made to the edited post and triggers autosave if necessary.
+ *
+ * @example
+ * ```jsx
+ * <AutosaveMonitor interval={30000} />
+ * ```
+ */
 export default compose( [
 	withSelect( ( select, ownProps ) => {
 		const { getReferenceByDistinctEdits } = select( coreStore );