Custom React Query Hook

VerifiedSafe

Generates a custom TanStack Query hook for data fetching, including queries and mutations. It reads the backend controller to confirm endpoint URLs and response types, then produces a typed hook using the project's Axios instance. Useful when creating API integration hooks that must follow team conventions and avoid stale cached data.

Sby Skills Guide Bot
DevelopmentIntermediate
6/2/2026
Claude Code
#react-query#data-fetching#custom-hook#typescript#tanstack-query

Recommended for

Automated summary

Generates a custom React Query hook for data fetching with proper typing.

Strengths

  • Strong typing aligned with backend DTOs
  • Automatic cache management with invalidation after mutations
  • Follows naming conventions and project structure guidelines

Limitations

  • Requires existing Axios configuration and defined backend endpoints
  • Does not handle complex cases like parallel queries or advanced pagination
When to use it

Use this skill when you need to create a React Query hook to interact with an existing REST API in a React application.

When not to use it

Avoid this skill if you are using a different state management library (e.g., Redux, Zustand) or if the API is not yet defined.

Security analysis

Safe
Quality score90/100

The skill only instructs an AI to read files and generate React/TypeScript code for data fetching using TanStack Query and Axios. There are no shell commands, no data exfiltration, no runtime evaluation, and no destructive actions. The file reads are within the project structure and do not introduce external risks.

No concerns found

How this analysis is made

Examples

Create a GET query hook for tasks
Generate a React Query hook for fetching a task by ID: GET /tasks/:id with response type Task.
Create a mutation hook to create a project
Generate a React Query mutation hook for creating a project via POST /projects. The hook should invalidate the 'projects' query on success.
Create a query hook for user list with pagination
Generate a React Query hook for fetching a paginated list of users from GET /users?page=1&limit=20. The hook should accept page and limit parameters and return data with total count.

name: react-query-hook description: Generate a custom React Query hook for data fetching with proper typing. Use when creating API integration hooks.

Generate React Query Hook

Create a custom hook using TanStack Query for data fetching.

Important: Follow the Learning Mode guidelines in _templates/learning-mode.md

Arguments

  • $ARGUMENTS - Hook name or API endpoint (e.g., "useTasks", "GET /projects/:id")

Pre-flight (BAT BUOC)

Truoc khi tao hook, DOC:

  1. apps/web/src/services/api.ts — confirm Axios instance config
  2. Backend controller tuong ung — confirm endpoint URL + response type
  3. .context/research/PITFALLS.md > React section — TanStack Query cache stale
  4. .context/research/CONVENTIONS.md > API Response Format

Instructions

Step 1: Clarify (Query vs Mutation, parameters)

Step 2: Read backend code (KHONG SKIP) — confirm endpoint URL + data shape

Step 3: Create the hook

Query (GET):

import { useQuery } from '@tanstack/react-query';
import { api } from '@/services/api';

export const use[Name] = (id: string) => {
  return useQuery({
    queryKey: ['[name]', id],
    queryFn: async () => {
      const { data } = await api.get<[Type]>(`/[endpoint]/${id}`);
      return data;
    },
    enabled: !!id,
  });
};

Mutation (POST/PATCH/DELETE):

import { useMutation, useQueryClient } from '@tanstack/react-query';
import { api } from '@/services/api';

export const use[Name] = () => {
  const queryClient = useQueryClient();
  return useMutation({
    mutationFn: async (input: [Type]) => {
      const { data } = await api.post('/[endpoint]', input);
      return data;
    },
    onSuccess: () => {
      queryClient.invalidateQueries({ queryKey: ['[related]'] });
    },
  });
};

Code Standards

  1. Naming: use[Action][Resource] — useGetTasks, useCreateProject
  2. Query Keys: Array ['resource', id, params]
  3. API client: LUON dung @/services/api — KHONG tao Axios instance moi
  4. Types: Match backend DTOs — KHONG tu bia type
  5. Response: Object truc tiep (khong wrapper), list { data, total, page, limit }

Pitfalls

  • enabled: !!dependency cho dependent queries
  • invalidateQueries() sau mutation — tranh stale cache
  • Destructure dung: const { data } = await api.get(...) — data la response body

After Completion

Remind user: "Test hook trong component" + "Update PROGRESS.md!"

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/custom-react-query-hook-mmk3nib9/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/custom-react-query-hook-mmk3nib9' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/custom-react-query-hook-mmk3nib9/download' --output '.skill-downloads/custom-react-query-hook-mmk3nib9/SKILL.md.part' && mv '.skill-downloads/custom-react-query-hook-mmk3nib9/SKILL.md.part' '.skill-downloads/custom-react-query-hook-mmk3nib9/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/custom-react-query-hook-mmk3nib9/SKILL.md' && test -s '.skill-downloads/custom-react-query-hook-mmk3nib9/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/react-query-hook' && cp -R '.skill-downloads/custom-react-query-hook-mmk3nib9' '.claude/skills/react-query-hook'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/custom-react-query-hook-mmk3nib9'

openskills read 'custom-react-query-hook-mmk3nib9'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/custom-react-query-hook-mmk3nib9/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills