mirror of
https://github.com/Heretek-AI/opencode.git
synced 2026-11-07 10:56:09 -10:00
docs(sdk): note SSE shutdown and compression on the embedded HTTP app
This commit is contained in:
1 parent
8d6737a481
commit
9b20d1d33a
1 file changed
+4
-2
@@ -32,8 +32,10 @@ export type Interface = Omit<OpenCodeClient, "plugin" | "workspace"> & {
|
||||
}
|
||||
readonly plugin: EmbeddedHost.Interface["plugins"]["register"] & OpenCodeClient["plugin"]
|
||||
/**
|
||||
* This instance's HTTP API for external opencode clients. Serve it with an Effect `HttpServer`; a fetch
|
||||
* handler cannot accept PTY WebSockets. Stop that server before closing this instance.
|
||||
* This instance's HTTP API for external opencode clients, with CORS but without response compression.
|
||||
* Serve it with an Effect `HttpServer`; a fetch handler cannot accept PTY WebSockets. Stop that server
|
||||
* before closing this instance. Node's server waits for open SSE streams, so call `closeAllConnections()`
|
||||
* when stopping it.
|
||||
*/
|
||||
readonly http: EmbeddedHost.Interface["http"]
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user