From 89175be558e9f2acffb6043e9f79abda02fec7a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Valverd=C3=A9?= Date: Wed, 26 Feb 2025 14:30:59 +0100 Subject: [PATCH] README work --- README.md | 5 +++++ packages/extension-lazyref/README.md | 13 ++----------- packages/reffuse/src/ReffuseHelpers.ts | 4 ++-- 3 files changed, 9 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 0d740c0..5464a71 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ # Reffuse Monorepo Reffuse is a [Effect-TS](https://effect.website/) integration for React 19+ with the aim of integrating the Effect context system within React's component hierarchy, while avoiding touching React's internals. + +This monorepo contains: +- [The `reffuse` library](packages/reffuse) +- [`@reffuse/extension-lazyref`](packages/extension-lazyref) +- [An example project](packges/example) diff --git a/packages/extension-lazyref/README.md b/packages/extension-lazyref/README.md index dab847a..c0651ae 100644 --- a/packages/extension-lazyref/README.md +++ b/packages/extension-lazyref/README.md @@ -1,12 +1,3 @@ -# Reffuse +# `@typed/lazy-ref` extension for Reffuse -[Effect-TS](https://effect.website/) integration for React 19+ with the aim of integrating the Effect context system within React's component hierarchy, while avoiding touching React's internals. - -This library is in early development. While it is (almost) feature complete and mostly usable, expect bugs and quirks. Things are still being ironed out, so ideas and criticisms are more than welcome. - -Documentation is currently being written. In the meantime, you can take a look at the `packages/example` directory. - -## Dependencies -(needs to be manually installed) -- `effect` -- `react` 19+ +## Peer dependencies diff --git a/packages/reffuse/src/ReffuseHelpers.ts b/packages/reffuse/src/ReffuseHelpers.ts index cd48191..6b8e5df 100644 --- a/packages/reffuse/src/ReffuseHelpers.ts +++ b/packages/reffuse/src/ReffuseHelpers.ts @@ -228,7 +228,7 @@ export abstract class ReffuseHelpers { ): void { const runSync = this.useRunSync() - return React.useLayoutEffect(() => { + React.useLayoutEffect(() => { const scope = Scope.make(options?.finalizerExecutionStrategy).pipe( Effect.tap(scope => Effect.provideService(effect(), Scope.Scope, scope)), runSync, @@ -277,7 +277,7 @@ export abstract class ReffuseHelpers { const runSync = this.useRunSync() const runFork = this.useRunFork() - return React.useEffect(() => { + React.useEffect(() => { const scope = runSync(options?.scope ? Scope.fork(options.scope, options?.finalizerExecutionStrategy ?? ExecutionStrategy.sequential) : Scope.make(options?.finalizerExecutionStrategy)