@procedures/node 0.2.2 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,55 @@
 # @procedures/node
 
+## 0.3.0
+
+### Minor Changes
+
+- 04cfef8: `node.logs` (roadmap R44) gives the output of a process that `node.spawn` started: the last 64 KiB of stdout and stderr that the process registry of `client-shell` keeps. With `lines`, it gives only the last lines. With `stripAnsi`, it removes the colors. It works also after the process ended, and it only reads (`reads: ["jobs"]`).
+
+### Patch Changes
+
+- Updated dependencies [ddea529]
+- Updated dependencies [b2a3e3a]
+- Updated dependencies [a8c47f1]
+- Updated dependencies [381ce3a]
+- Updated dependencies [0c627f8]
+- Updated dependencies [ae7f05f]
+- Updated dependencies [7873940]
+- Updated dependencies [a70d445]
+- Updated dependencies [bc70357]
+- Updated dependencies [07cc998]
+- Updated dependencies [a6b01a9]
+- Updated dependencies [c799cdd]
+- Updated dependencies [540f8d9]
+- Updated dependencies [b6daaec]
+- Updated dependencies [5b9264e]
+- Updated dependencies [956e88b]
+- Updated dependencies [ff62281]
+- Updated dependencies [d81d0ed]
+- Updated dependencies [aa67cc7]
+- Updated dependencies [061fa22]
+- Updated dependencies [cfb9d69]
+- Updated dependencies [43f7de5]
+- Updated dependencies [b07bb50]
+- Updated dependencies [4a3bfa1]
+- Updated dependencies [bd0b626]
+- Updated dependencies [a6be873]
+- Updated dependencies [fb30718]
+- Updated dependencies [c5528e4]
+- Updated dependencies [fee5d9c]
+- Updated dependencies [21f7743]
+- Updated dependencies [31a0b46]
+  - @procedures/client@0.3.0
+  - @procedures/shell@0.3.0
+
+## 0.2.3
+
+### Patch Changes
+
+- Updated dependencies [15e48cf]
+  - @procedures/client@0.2.3
+  - @procedures/shell@0.2.3
+
 ## 0.2.2
 
 ### Patch Changes

package/README.md

@@ -14,6 +14,7 @@ Node.js process management procedures for the client ecosystem. Provides procedu
 │   await client.exec(["node", "spawn"], { script: "server.js" })             │
 │   await client.exec(["node", "kill"], { processId: "abc123" })              │
 │   await client.exec(["node", "status"], {})                                 │
+│   await client.exec(["node", "logs"], { processId: "abc123", lines: 50 })   │
 │                                                                              │
 └─────────────────────────────────┬───────────────────────────────────────────┘
                                   │
@@ -62,6 +63,8 @@ pnpm add @procedures/node
 
 ## Procedures
 
+The package has 5 procedures. Its register entry (`import "@procedures/node/register"`) registers them: `node.run`, `node.spawn`, `node.kill`, `node.status`, `node.logs`.
+
 ### node.run
 
 Run a Node.js script to completion and return the output.
@@ -217,6 +220,28 @@ for (const proc of result.processes) {
 | `status` | `"running" \| "stopped"` | Process status |
 | `startedAt` | `string` | ISO timestamp when started |
 
+### node.logs
+
+The procedure gives the output of one process that `node.spawn` started. The process registry of `client-shell` reads the output of each process and keeps its end: the last 64 KiB of stdout and stderr together. Thus the procedure gives that end, also after the process ended. The registry keeps the records of the last 50 ended processes.
+
+```typescript
+const { status, exitCode, output } = await client.exec(["node", "logs"], {
+  processId: "node-abc123-1",
+  lines: 50,
+  stripAnsi: true,
+});
+```
+
+The input has these fields:
+
+- `processId` (necessary): the process ID that `node.spawn` gave.
+- `lines`: give only the last lines of the output.
+- `stripAnsi`: remove the ANSI escape codes (colors) from the output.
+
+The output has the `processId`, the `status` (`running`, `exited` or `error`), the `exitCode` of an ended process and the `output`.
+
+The procedure knows only the processes of its host. The process writes to two pipes, stdout and stderr. Thus `output` has their lines in the order of their arrival. A process that `node.spawn` did not start is an error. The procedure has no stream: a stream of new output needs a subscription to the process registry of `client-shell`.
+
 ## Process Lifecycle
 
 ```