convex-functions

Compose Convex queries, mutations, actions, and HTTP actions with validators.

7|Updated Feb 16, 2025
One-click install
npx skills add https://github.com/shahbaz-athwal/acadia-one --skill convex-functions-shahbaz-athwal
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-functions
Source: https://github.com/shahbaz-athwal/acadia-one/tree/main/.agents/skills/convex-functions
Command: npx skills add https://github.com/shahbaz-athwal/acadia-one --skill convex-functions-shahbaz-athwal

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a comprehensive, standards-based pattern library for building robust Convex function backends by composing queries, mutations, actions, and HTTP actions, ensuring proper validation and structured error handling.

Core Features & Use Cases

  • Type-safe validators for args and returns across queries, mutations, actions, and HTTP actions.
  • Clear separation of concerns with internal functions for sensitive logic and reusable patterns for external integrations.
  • Supports scheduling, webhooks, and end-to-end examples across typical Convex projects.

Quick Start

Install the convex toolkit and begin implementing example queries, mutations, actions, and HTTP actions with proper validation.

Frequently Asked Questions about convex-functions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build type-safe Convex functions for queries and mutations?

To build type-safe Convex functions, you must implement robust validators for arguments and returns across queries and mutations. This approach ensures structured error handling and enforces strict data access patterns within your server-side backend code.

What is the best way to handle webhooks and external integrations in Convex?

The best way to handle webhooks and external integrations in Convex is by composing HTTP actions with type-safe validators. This method provides a clear separation of concerns and establishes reusable patterns for external endpoints.

When should I use internal functions for sensitive backend logic in Convex?

Use internal functions for sensitive backend logic when you need a clear separation of concerns in your Convex project. This practice secures vulnerable data access patterns by isolating sensitive operations from external queries and mutations.

How does Convex handle event scheduling and server-side data access?

Convex handles event scheduling and server-side data access by composing actions and queries with proper validation. This architecture allows developers to structure robust backends while maintaining type-safe API boundaries for scheduled tasks.

Do I need type-safe validators for Convex HTTP actions and mutations?

Yes, you need type-safe validators for Convex HTTP actions and mutations to ensure proper validation and structured error handling. Defining strict argument and return types prevents runtime errors and secures server-side data access patterns.