Convex CommunityCCConvex Community
Powered by
djbalinD
Convex Community•8mo ago•
2 replies
djbalin

Would you use this: `useEffectQuery`

TL;DR: Would you use this as a wrapper around
convex.query
convex.query
?
const { data, error, status, runQuery } = useEffectQuery(query, args, deps?)
const { data, error, status, runQuery } = useEffectQuery(query, args, deps?)


☀️ Motivation: reducing
convex.query
convex.query
boilerplate ☀️
I use the imperative
useConvex
useConvex
hook quite a lot whenever I want to opt-out of the default reactivity behavior. However, the approach is always the same and contains a lot boilerplate code and local state management.

I have identified some of my typical use cases of the imperative
convex.query
convex.query
:

1. Run query on component mount: (
useEffect(() => { convex.query() }, [])
useEffect(() => { convex.query() }, [])
)
2. Re-run query when some local state changes (
useEffect(() => { convex.query() }, [myLocalState])
useEffect(() => { convex.query() }, [myLocalState])
)
3. Re-run query based on user actions (
handleButtonClick() { convex.query }
handleButtonClick() { convex.query }
)
4. Some or all of the above in the same component


⭐ Proposal:
useEffectQuery
useEffectQuery
🌟
A
useEffect
useEffect
-inspired hook that is an abstraction/wrapper of
useConvex()
useConvex()
and
useEffect
useEffect
. I pasted two images of some usage example, showing the new approach compared to the vanilla

The query passed to the
useEffectQuery
useEffectQuery
hook is only reactive to the
deps
deps
array (like
useEffect
useEffect
), and is not reactive to neither
args
args
nor the underlying data
.

It also contains goodies inspired by the richer useQuery https://www.npmjs.com/package/convex-helpers#richer-usequery such as status and returning errors as values.

------------------------------------------------

🙏 Would you use this? 🙏
ex2.png
ex3.png
npm
convex-helpers
A collection of useful code to complement the official convex package.. Latest version: 0.1.96, last published: 19 hours ago. Start using convex-helpers in your project by running
npm i convex-helpers
npm i convex-helpers
. There are 15 other projects in the npm registry using convex-helpers.
convex-helpers
Convex Community banner
Convex CommunityJoin
Join the Convex Discord! Explore Convex, the backend platform that keeps your app in sync.
15,138Members
Resources
Was this page helpful?

Similar Threads

Recent Announcements
Recent Announcements
james

Hi @everyone with everything going on today I forgot to post on discord about our EU launch! We have a region in Dublin now! You can start using it immediately, even for folks on the free plan. https://news.convex.dev/we-finally-got-our-eu-visa/ Stay tuned for more regions but also stay tuned for more infra improvements where we improve latency for teams no matter where their servers are located. Just at the tip of the iceberg re all the optimizations we have lined up.

james · 4d ago

Wayne

Hi @everyone happy Monday. Components Authoring [Challenge](https://www.convex.dev/components/challenge) updates! Meet the second batch of community-approved components **Firecrawl Scrape **- Scrape any URL and get clean markdown, HTML, screenshots, or structured JSON - with durable caching and reactive queries. https://www.convex.dev/components/firecrawl-scrape Built by: Gitmaxd **Durable Agents **- A Convex component for building durable AI agents with an async tool loop. https://www.convex.dev/components/durable-agents Built by: Siegfried **Convex Debouncer** - A server-side debouncing component for debouncing expensive operations like LLM calls, metrics computation, or any heavy processing that should only run after a period of inactivity. https://www.convex.dev/components/debouncer Built by: Ilya **DatabaseChat **- A Convex component for adding natural language database queries to your app. https://www.convex.dev/components/database-chat Built by: Nick **Transloadit** - A Convex component for creating Transloadit Assemblies, handling resumable uploads with status, and persisting status/results in Convex. https://www.convex.dev/components/transloadit Built by: Kvz **Loops** - A Convex component for integrating with Loops.so email marketing platform. https://www.convex.dev/components/loops Built by: Bobby The [challenge](https://www.convex.dev/components/challenge) is now ongoing, so keep building, and we'll keep rewarding. Thanks, everyone!

Wayne · 3w ago

Liz C

Hi everyone! Have you ever wanted to get your hands on some convex swag? Well you're in luck! We just launched our Convex swag store. Check it out here ---> https://store.convex.dev/

Liz C · 3w ago

Similar Threads

How would you structure this schema?
mikeyseeMmikeysee / support-community
3y ago
How would you architect this in Convex?
ThallesComHTThallesComH / support-community
6mo ago
How would you handle third party subscriptions in convex
sonandmjySsonandmjy / support-community
13mo ago
Do you have to use exactly one schema.ts?
cyremurCcyremur / support-community
3y ago