Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/machikado-network/kuiper
A HTTP Client for Cloudflare Workers
https://github.com/machikado-network/kuiper
cloudflare cloudflare-workers javascript npm wrapper
Last synced: 3 days ago
JSON representation
A HTTP Client for Cloudflare Workers
- Host: GitHub
- URL: https://github.com/machikado-network/kuiper
- Owner: machikado-network
- License: mit
- Created: 2022-11-22T05:14:09.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-24T12:56:14.000Z (about 2 years ago)
- Last Synced: 2025-01-01T18:46:12.818Z (about 1 month ago)
- Topics: cloudflare, cloudflare-workers, javascript, npm, wrapper
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@machikado-network/kuiper
- Size: 2.29 MB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# kuiper
[](https://github.com/machikado-network/kuiper/blob/main/LICENSE)
[](https://www.npmjs.com/package/@machikado-network/kuiper)
[](https://www.npmjs.com/package/@machikado-network/kuiper)
Kuiper is a HTTP Client that is Cloudflare Workers fetch function's wrapper.
```typescript
import kuiper from "@machikado-network/kuiper";
export default {
async fetch(request: Request) {
const response = await kuiper.post("https://httpbin.org/post", {key: "value"})
return new Response(response.body, response)
}
}
```
# Installing
```shell
$ npm install @machikado-network/kuiper
```
# Features
- **JSON Wrapper** - automatic JSON transforms
- **Fetcher support** - Service Bindings support
# ToDo
- [ ] **Request Builder**
- [ ] **Cache Control**
- [x] **Full Method Support**
# Example
```typescript
import kuiper from "@machikado-network/kuiper";
export default {
async fetch(request: Request) {
const response = await kuiper.post("https://httpbin.org/post", {key: "value"})
return new Response(response.body, response)
}
}
```
You can use Fetcher from [Service Bindings](https://developers.cloudflare.com/workers/runtime-apis/service-bindings/):
```typescript
import kuiper from "@machikado-network/kuiper";
interface Env {
api: Fetcher
}
export default {
async fetch(request: Request, env: Env) {
const response = await kuiper(env.api).post("https://httpbin.org/post", {key: "value"})
return new Response(response.body, response)
}
}
```
## Provider
Kuiper Provider is a type-based API wrapper for Cloudflare Workers.
Its feature is:
- Compile-time checking for endpoints type definitions.
- Supports Service Bindings.
First, define API routes and argument types:
```typescript
enum ApiRoutes {
testGet = "/get",
testPost = "/post",
}
type ApiTasks =
Task |
Task
```
Second, improve service class.
```typescript
class ApiService extends Service {
baseUrl = "https://httpbin.org"
constructor(fetcher?: Fetcher) {
// You can set Service Bindings fetcher in constructor
super(fetcher)
}
headers(_route: ApiRoutes): [string, string][] {
return [["Content-Type", "application/json"]]
}
methods(route: ApiRoutes): Method {
switch (route) {
case ApiRoutes.testGet:
return "GET"
case ApiRoutes.testPost:
return "POST"
}
}
tasks([route, data]: ApiTasks): Parameters {
switch (route) {
case ApiRoutes.testGet:
return {}
case ApiRoutes.testPost:
return {body: data}
}
}
}
```
You can use async function if you want in headers, methods, tasks.
Third, create Provider instance and request with route and task:
```typescript
const provider = new Provider(new ApiService())
const response = await provider.request([ApiRoutes.testGet, null])
```