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

@rtk-incubator/rtk-query-codegen-openapi

v0.5.1

Published

<p align="center"> <img src="https://raw.githubusercontent.com/rtk-incubator/rtk-query/main/logo.png" width="400" /> </p> <h2 align="center"> Code Generator </h2>

Downloads

2,680

Readme

Introduction

This is a utility library meant to be used with RTK Query that will generate a typed API client from an OpenAPI schema.

Usage

By default, running the CLI will only log the output to the terminal. You can either pipe this output to a new file, or you can specify an output file via CLI args.

Piping to a file (including react hooks generation)

npx @rtk-incubator/rtk-query-codegen-openapi --hooks https://petstore3.swagger.io/api/v3/openapi.json > petstore-api.generated.ts

Specifying an output file (including react hooks generation)

npx @rtk-incubator/rtk-query-codegen-openapi --file petstore-api.generated.ts --hooks https://petstore3.swagger.io/api/v3/openapi.json

Using a custom baseQuery

npx @rtk-incubator/rtk-query-codegen-openapi --file generated.api.ts --baseQuery ./customBaseQuery.ts:namedBaseQueryFn --hooks https://petstore3.swagger.io/api/v3/openapi.json

CLI Options

  • --exportName <name> - change the name of the exported api (default: api)
  • --reducerPath <path> - change the name of the reducerPath (default: api)
  • --baseQuery <file> - specify a file with a custom baseQuery function. Optionally takes a named function in that file. (default: fetchBaseQuery - ex: ./customBaseQuery.ts:myCustomBaseQueryFn)
  • --argSuffix <name> - change the suffix of the arg type (default: ApiArg - ex: AddPetApiArg)
  • --responseSuffix <name> - change the suffix of the response type (default: ApiResponse - ex: AddPetApiResponse)
  • --baseUrl <url> - set the baseUrl when using fetchBaseQuery (will be ignored if you pass --baseQuery)
  • --createApiImportPath <path> - set the entry point to import createApi from. Currently only react is available. Defaults to react if --hooks is passed.
  • --hooks - include React Hooks in the output (ex: export const { useGetModelQuery, useUpdateModelMutation } = api)
  • --file <filename> - specify a filename to output to (ex: ./generated.api.ts)

Documentation

View the RTK Query Code Generation docs