UmweltDocs
Reference/Commands/shutdown
shutdowncommandsince 0.1

Ends a umwelt serve session cleanly: the file is checkpointed, the answer is sent, and the process exits.

Request
umwelt serve story.umw
{"v":1,"id":"42","op":"shutdown","payload":{}}
Request
const result = await client.shutdown({});
Request
var result = engine.Shutdown(new EmptyPayload());
Response
{}

Payload

No fields: the payload is {}.

Result

An empty object: {}.

Rules

End of input does the same. Closing standard input checkpoints the file and exits too, without sending an answer.

Clients send it for you. The TypeScript client sends it when you close() it.

Errors

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

See also

Was this page helpful?