mirror of
https://github.com/syumai/workers.git
synced 2025-03-10 17:29:11 +00:00
85 lines
2.7 KiB
Markdown
85 lines
2.7 KiB
Markdown
# workers
|
|
|
|
[](https://pkg.go.dev/github.com/syumai/workers)
|
|
[](https://discord.gg/tYhtatRqGs)
|
|
|
|
* `workers` is a package to run an HTTP server written in Go on [Cloudflare Workers](https://workers.cloudflare.com/).
|
|
* This package can easily serve *http.Handler* on Cloudflare Workers.
|
|
* Caution: This is an experimental project.
|
|
|
|
## Features
|
|
|
|
* [x] serve http.Handler
|
|
* [ ] R2
|
|
- [x] Head
|
|
- [x] Get
|
|
- [x] Put
|
|
- [x] Delete
|
|
- [x] List
|
|
- [ ] Options for R2 methods
|
|
* [ ] KV
|
|
- [x] Get
|
|
- [x] List
|
|
- [x] Put
|
|
- [x] Delete
|
|
- [ ] Options for KV methods
|
|
* [ ] Cache API
|
|
* [ ] Durable Objects
|
|
- [x] Calling stubs
|
|
* [x] D1 (alpha)
|
|
* [x] Environment variables
|
|
* FetchEvent's [lifecycle methods](https://developers.cloudflare.com/workers/runtime-apis/fetch-event/#lifecycle-methods)
|
|
- [x] waitUntil
|
|
- [ ] respondWith
|
|
- [ ] passThroughOnException
|
|
|
|
## Installation
|
|
|
|
```
|
|
go get github.com/syumai/workers
|
|
```
|
|
|
|
## Usage
|
|
|
|
implement your http.Handler and give it to `workers.Serve()`.
|
|
|
|
```go
|
|
func main() {
|
|
var handler http.HandlerFunc = func (w http.ResponseWriter, req *http.Request) { ... }
|
|
workers.Serve(handler)
|
|
}
|
|
```
|
|
|
|
or just call `http.Handle` and `http.HandleFunc`, then invoke `workers.Serve()` with nil.
|
|
|
|
```go
|
|
func main() {
|
|
http.HandleFunc("/hello", func (w http.ResponseWriter, req *http.Request) { ... })
|
|
workers.Serve(nil) // if nil is given, http.DefaultServeMux is used.
|
|
}
|
|
```
|
|
|
|
For concrete examples, see `examples` directory.
|
|
Currently, all examples use tinygo instead of Go due to binary size issues.
|
|
|
|
A template repository is also available.
|
|
* https://github.com/syumai/worker-template-tinygo
|
|
|
|
## FAQ
|
|
|
|
### How do I deploy a worker implemented in this package?
|
|
|
|
To deploy a Worker, the following steps are required.
|
|
|
|
* Create a worker project using [wrangler](https://developers.cloudflare.com/workers/wrangler/).
|
|
* Build a Wasm binary.
|
|
* Upload a Wasm binary with a JavaScript code to load and instantiate Wasm (for entry point).
|
|
|
|
The [worker-template-tinygo](https://github.com/syumai/worker-template-tinygo) repository contains all the required files, so I recommend using this template.
|
|
|
|
The [worker-template-go](https://github.com/syumai/worker-template-go) repository (using regular Go, not tinygo) is also available, but it requires a paid plan of Cloudflare Workers (due to the large binary size).
|
|
|
|
### Where can I have discussions about contributions, or ask questions about how to use the library?
|
|
|
|
You can do both through GitHub Issues. If you want to have a more casual conversation, please use the [Discord server](https://discord.gg/tYhtatRqGs).
|