cppmodel 0.9.0 → 0.9.1

package/README.md

@@ -82,9 +82,10 @@ Inputs and outputs are numbers. Parameters keep their JSON type. All three have
 - **`run()` is synchronous.** It blocks the event loop until the simulation has finished, which is
   fine for scripts and tests. In a server, run simulations in a
   [worker thread](https://nodejs.org/api/worker_threads.html).
-- **Workspace access:** set `CPPMODEL_USERNAME` and `CPPMODEL_PASSWORD` for scripts and CI. Pass
-  `{ offline: true }` to run without the workspace. Without credentials, the first run prints a
-  sign-in link and waits until you've signed in.
+- **Workspace access:** every run reads its inputs from and records its execution in your
+  workspace. Set `CPPMODEL_USERNAME` and `CPPMODEL_PASSWORD` for scripts and CI. Without
+  credentials, the first run prints a sign-in link and waits 60 seconds for you to sign in
+  (`CPPMODEL_LOGIN_TIMEOUT` changes that, in seconds); without a sign-in, `run()` throws.
 - **Fingerprint:** each execution records a `CppModel.BinaryFingerprint` of the simulation's code,
   so the workspace can tell runs of the same code from runs of changed code. It is the fingerprint
   of the file that creates the simulation. Set `sim.fingerprintFile` to use another file.

package/index.d.ts

@@ -69,7 +69,7 @@ export declare class Parameters {
 }
 
 export interface SimulationOptions<S extends Simulation = Simulation> {
-    /** When true, run() doesn't reach the workspace: nothing is fetched or submitted. */
+    /** When true, run() doesn't reach the workspace and then throws: a run that skips the workspace verifies nothing. */
     offline?: boolean;
     init?: (simulation: S) => void;
     step?: (simulation: S, timeMs: number) => void;

package/index.js

@@ -393,7 +393,10 @@ class Simulation {
         check(c.setTiming(this._live(), this.totalTimeMs, value));
     }
 
-    /** When true, run() doesn't reach the workspace: nothing is fetched or submitted. */
+    /**
+     * When true, run() doesn't reach the workspace: nothing is fetched or submitted, and run() then
+     * throws, because a run that skips the workspace verifies nothing.
+     */
     get offline() {
         return this.#offline;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cppmodel",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Write CppModel simulations in Node.js",
   "keywords": ["cppmodel", "simulation", "plant model", "testing", "embedded"],
   "homepage": "https://cppmodel.com",