Type-safe HTTP requests with [ky](https://github.com/sindresorhus/ky) and TypeScript.
npm install typed-kyType-safe HTTP requests with ky and TypeScript.
- ðŊ Full TypeScript support with route-level type safety
- ð Type-checked request bodies and search parameters
- ðĶ Built on top of the excellent ky HTTP client
- ðŠķ Zero runtime overhead
- ð Great IDE autocompletion
``bash`
npm install typed-kyor
yarn add typed-kyor
pnpm add typed-kyor
bun add typed-ky
1. Define your API routes and their types:
`typescript`
interface MyApiRoutes {
"users/create": {
POST: {
requestJson: { name: string; email: string }
responseJson: { id: string; name: string }
}
}
"users/get": {
GET: {
searchParams: { id: string }
responseJson: { user: { id: string; name: string } }
}
}
}
2. Create a typed client:
`typescript
import { createTypedKy } from 'typed-ky'
const api = createTypedKy
prefixUrl: 'https://api.example.com'
})
`
3. Make type-safe requests:
`typescript
// POST request with typed body
const newUser = await api.post('users/create', {
json: {
name: 'John Doe',
email: 'john@example.com'
}
})
// newUser is typed as { id: string; name: string }
// GET request with typed search params
const user = await api.get('users/get', {
searchParams: { id: '123' }
})
// user is typed as { user: { id: string; name: string } }
`
- Type Safety: Catch API integration errors at compile time
- Developer Experience: Get autocomplete for routes, parameters, and response types
- Maintainable: Single source of truth for API types
- Lightweight: Just a thin wrapper around ky with zero runtime overhead
Creates a typed HTTP client instance.
- Paths: Union type of all route pathsRoutes
- : Route definitions with request/response typesoptions
- : All ky options are supported
Returns an instance with typed methods:
- get(route, options)
-
-
-
-
MIT