docs: add jsdoc for withLazyViewModel HOC

js2me · js2me · commit 612a7aafca29 · 2025-07-07T12:30:20.000+03:00
diff --git a/.changeset/nasty-peas-love.md b/.changeset/nasty-peas-love.md
@@ -0,0 +1,5 @@
+---
+"mobx-view-model": patch
+---
+
+add jsdoc for `withLazyViewModel` HOC
diff --git a/src/hoc/with-lazy-view-model.tsx b/src/hoc/with-lazy-view-model.tsx
@@ -30,7 +30,7 @@ export interface LazyViewModelHocConfig<TViewModel extends AnyViewModel>
     Pick<LoadableConfig, 'loading' | 'preload' | 'throwOnError'> {}
 
 /**
- * Lazy creates new instance of ViewModel
+ * A Higher-Order Component that **LAZY** connects React components to their ViewModels, providing seamless MobX integration.
  *
  * [**Documentation**](https://js2me.github.io/mobx-view-model/react/api/with-lazy-view-model.html)
  */

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"mobx-view-model": patch
 +---
++
 +add jsdoc for `withLazyViewModel` HOC
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ export interface LazyViewModelHocConfig<TViewModel extends AnyViewModel>`
`30`	`30`	`Pick<LoadableConfig, 'loading' \| 'preload' \| 'throwOnError'> {}`
`31`	`31`
`32`	`32`	`/**`
`33`		`- * Lazy creates new instance of ViewModel`
	`33`	`+ * A Higher-Order Component that LAZY connects React components to their ViewModels, providing seamless MobX integration.`
`34`	`34`	`*`
`35`	`35`	`* [Documentation](https://js2me.github.io/mobx-view-model/react/api/with-lazy-view-model.html)`
`36`	`36`	`*/`