npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@rapper3/react-query3

v0.2.1

Published

Combine Rapper3 with powerful React Query.

Downloads

2

Readme

@rapper3/react-query3

Combine Rapper3 with powerful React Query.

Getting Started


1. Install Rapper3 http, React Query and @rapper3/react-query3 in your project.

npm install --save @rapper3/cli @rapper3/request react-query@^3 @rapper3/react-query3

Generate TypeScript code in your project.

Remember to add QueryClientProvider. (React Query Quick Start)

import { QueryClient, QueryClientProvider } from 'react-query';

// Create a client
const queryClient = new QueryClient();

function App() {
  return (
    // Provide the client to your App
    <QueryClientProvider client={queryClient}>
      <Todos />
    </QueryClientProvider>
  );
}

Create the hooks using generated code.

import * as React from 'react';
import { createUseRapperQuery } from '@rapper3/react-query3';
import { fetch } from 'src/rapper';

const useRapperQuery = createUseRapperQuery(fetch);

const Component: React.FC = () => {
  const { data, isLoading } = useRapperQuery('GET/path/to/your/api', {
    param1: 'value',
  });

  if (isLoading) {
    return <div>Loading...</div>;
  }

  return <div>{data.data}</div>;
};

API Reference

createUseRapperQuery

Combine Rapper with useQuery in react-query. It's usually used for read-only APIs (GET method).

  • url: string: The URL of your API.
  • params?: object: The params of your API.
  • options?: UseQueryOptions: The options for useQuery.

createUseRapperQueries

Combine Rapper with useQueries in react-query. Most time, you can use several useQuery to fetch multiple APIs. Use useQueries if your count of requests is undetermined.

  • requests: [string, object][]
    • requests[number][0]: The URL of your API.
    • requests[number][1]: The params of your API.
  • options?: QueriesOptions: The options for useQueries.

createUseMutation

Combine Rapper with useMutation in react-query. It's usually used for mutation APIs (POST/PUT/PATCH/DELETE method).

  • url: string: The URL of your API.
  • options?: UseMutationOptions: The options for useMutation.

createUseInfiniteQuery

Combine Rapper with useInfiniteQuery in react-query. It's usually used for infinite pagination APIs. For normal page/number paginations, you can just use a useQuery.

  • url: string: The URL of your API.
  • params?: object: The params of your API.
  • options?: UseInfinityQueryOptions: The options for useInfinityQuery.