composeGenerated
Category: Creation protocol · Session
Changes the scene: rewrites its document on disk (document and status name it), or with path or documents the scene’s other documents too, once the texts are checked; answered once the scene stands. A refused text writes nothing and is an error: why, at line and column, the document’s version, and for edits the text they made, which line counts in.
Description
Section titled “Description”Changes the scene: rewrites its document on disk (document and status name it), or with path or documents the scene’s other documents too, once the texts are checked; answered once the scene stands. A refused text writes nothing and is an error: why, at line and column, the document’s version, and for edits the text they made, which line counts in.
Example request
Section titled “Example request”{"id": 1, "op": "compose"}Properties
Section titled “Properties”| Name | Type | Required | Description |
|---|---|---|---|
text |
string |
no | the whole document; or edits |
edits |
[{node?: string, output?: string, param?: string, require?: string, input?: string, kernel?: string, struct?: string, type?: string, fn?: string, use?: string, member?: string, text: string | null}] |
no | each names a statement, or a node’s member, with its new text or null to remove it |
expect |
string |
no | the version document answered; refused when the scene changed since |
path |
string |
no | another document of the scene, from its directory: a .ent or .esn under it that the scene uses or places, or a new one this compose makes it use, or a .replay that names a scene there |
documents |
[{path?: string, text?: string, edits?: [{node?: string, output?: string, param?: string, require?: string, input?: string, kernel?: string, struct?: string, type?: string, fn?: string, use?: string, member?: string, text: string | null}], expect?: string}] |
no | several documents changed as one: all checked together, all written or none |
Answer
Section titled “Answer”events, version, path (the scene), written; with path or documents, documents (each written document’s path and version)