Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
typed-axios-instance
Advanced tools
Readme
typed-axios-instance
Typed Axios Instance is a simple way to create an Axios instance that is fully typed with the routes from an API.
The benefit of using TypedAxiosInstance is you don't need to create or import a client for a third party API, you can just apply types (generated from OpenAPI or Nextlove) to an existing Axios instance.
import type { TypedAxios } from "typed-axios-instance"
import axios from "axios"
// Need help generating these routes? You can generate them from...
// nextlove: https://github.com/seamapi/nextlove
// openapi: TODO
type Routes = [
{
route: "/things/create"
method: "POST"
jsonBody: {
name?: string | undefined
}
jsonResponse: {
thing: {
thing_id: string
name: string
created_at: string | Date
}
}
}
]
const myAxiosInstance: TypedAxios<Routes> = axios.create({
baseURL: "http://example-api.com",
})
// myAxiosInstance now has intelligent autocomplete!
npm add --dev typed-axios-instance
# yarn add --dev typed-axios-instance
There are two ways of specifying routes for TypedAxios<Routes>
type Routes = RouteDef[]
type Routes = { [route:string]: RouteDef }
Using
RouteDef[]
allows you to do HTTP Method Discrimination and is the recommended method.
This is the type for RouteDef
:
export type RouteDef = {
route: string
method: HTTPMethod // you can supply multiple e.g. `"PATCH" | "POST"`
// INPUTS
queryParams?: Record<string, any>
jsonBody?: Record<string, any>
commonParams?: Record<string, any>
formData?: Record<string, any>
// RESPONSES
jsonResponse?: Record<string, any>
}
There are two ways of specifying route definitions, if you specify the route definitions as an array (default for OpenAPI schemas), you'll get more specific autocomplete results, e.g. the response or request type will be based on what method is being used.
FAQs
Typed Axios is a simple way to create an Axios instance that is fully typed with the routes from an application.
The npm package typed-axios-instance receives a total of 3,866 weekly downloads. As such, typed-axios-instance popularity was classified as popular.
We found that typed-axios-instance demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.