Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add README for Jotai's Effect utility #2173

Merged
merged 1 commit into from
Oct 12, 2023

Conversation

dmaskasky
Copy link
Collaborator

Summary

doc: Add README for Jotai's Effect utility

  • Introduce documentation for the Effect utility in Jotai.
  • Provide a brief description and usage of the Effect utility.
  • Include installation instructions for jotai-effect.
  • Detail the atomEffect utility function, including parameters, usage, and advanced behaviors.
  • Offer insights and examples on atomEffect behavior like cleanup functions, resistance to infinite loops, execution timing, batching updates, conditional running, idempotency, and dependency management.

Check List

  • yarn run prettier for formatting code and docs

@vercel
Copy link

vercel bot commented Oct 11, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
jotai ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 12, 2023 0:11am

@codesandbox-ci
Copy link

codesandbox-ci bot commented Oct 11, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 3b4faa8:

Sandbox Source
React Configuration
React TypeScript Configuration
React Browserify Configuration
React Snowpack Configuration
Next.js Configuration
Next.js with custom Babel config Configuration
React with custom Babel config Configuration

Copy link
Member

@dai-shi dai-shi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dai-shi
Copy link
Member

dai-shi commented Oct 11, 2023

please run yarn run prettier.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants