v0.7.0

回應與 SSE

最後更新


HakoRun 如何把函式輸出轉成 JSON 回應,以及串流模式的事件格式。

型別標註


非串流模式回傳 {"data": ..., "type": ...}。結果取自 stdout 由下往上第一行合法 JSON;沒有合法 JSON 時,取過濾掉 Node.js 警告(Warning:、ExperimentalWarning 等)後的全部輸出。
type條件範例 data
stringJSON 字串"done"
numberJSON 數值8
jsonJSON 物件、陣列、布林或 null{"sum": 30}
text不是合法 JSONhello world

SSE 事件


stream: true 時回應標頭為 text/event-stream,每則事件為一行 data: <JSON>:
  1. data: {"event":"log","data":0,"type":"number"}
  2. data: {"event":"result","data":"done","type":"string"}

event送出時機
logstdout 每一行在下一行出現時送出
result行程正常結束,內容為 stdout 最後一行
errorstderr 有輸出、逾時、客戶端斷線或非零退出碼

每則事件的 type 依上表規則判斷;result/error 內的換行字元會被替換成空白。

結束與中止


  • 送出 result 或 error 後,伺服器 hijack 並關閉連線。
  • stderr 的第一行輸出即觸發終止,error 內容為 stopped to run script: <該行>。
  • 客戶端斷線時,error 為 stopped to run script: client disconnected(客戶端不會收到)。

相關頁面


EN