doc: document local parameter option

src/client/ClientContext.js

@@ -215,7 +215,7 @@ class ClientContext {
     // we need the try/catch block to change the promise rejection into proper error
     try {
       await new Promise((resolve, reject) => {
-        const reqId = promiseStore.add(resolve, reject, 'enter-context');
+        const reqId = promiseStore.add(resolve, reject, 'ClientContext#enter');
         this.#client.socket.send(CONTEXT_ENTER_REQUEST, reqId, this.name);
       });
     } catch (err) {
@@ -249,7 +249,7 @@ class ClientContext {
     // we need the try/catch block to change the promise rejection into proper error
     try {
       await new Promise((resolve, reject) => {
-        const reqId = promiseStore.add(resolve, reject, 'exit-context');
+        const reqId = promiseStore.add(resolve, reject, 'ClientContext#exit');
         this.#client.socket.send(CONTEXT_EXIT_REQUEST, reqId, this.name);
       });
     } catch (err) {

src/common/BaseStateManager.js

@@ -267,7 +267,7 @@ class BaseStateManager {
     }
 
     return new Promise((resolve, reject) => {
-      const reqId = this.#promiseStore.add(resolve, reject, 'create-request');
+      const reqId = this.#promiseStore.add(resolve, reject, 'BaseStateManager#create');
       const requireDescription = this.#cachedClasses.has(className) ? false : true;
       this[kStateManagerClient].transport.emit(CREATE_REQUEST, reqId, className, requireDescription, initValues);
     });
@@ -376,7 +376,7 @@ class BaseStateManager {
     }
 
     return new Promise((resolve, reject) => {
-      const reqId = this.#promiseStore.add(resolve, reject, 'attach-request');
+      const reqId = this.#promiseStore.add(resolve, reject, 'BaseStateManager#attach');
       const requireDescription = this.#cachedClasses.has(className) ? false : true;
       this[kStateManagerClient].transport.emit(ATTACH_REQUEST, reqId, className, stateId, requireDescription, filter);
     });
@@ -559,7 +559,7 @@ class BaseStateManager {
 
     // resend request to get updated list of states
     return new Promise((resolve, reject) => {
-      const reqId = this.#promiseStore.add(resolve, reject, 'observe-request');
+      const reqId = this.#promiseStore.add(resolve, reject, 'BaseStateManager#observe');
       // store the callback for execution on the response. the returned Promise
       // is fullfiled once callback has been executed with each existing states
       const observeInfos = [observedClassName, callback, options];

src/common/SharedState.js

@@ -520,7 +520,7 @@ ${JSON.stringify(initValues, null, 2)}`);
 
     // go through server-side normal behavior
     return new Promise((resolve, reject) => {
-      const reqId = this[kSharedStatePromiseStore].add(resolve, reject, 'update-request', forwardParams);
+      const reqId = this[kSharedStatePromiseStore].add(resolve, reject, 'SharedState#set', forwardParams);
       this.#client.transport.emit(`${UPDATE_REQUEST}-${this.#id}-${this.#remoteId}`, reqId, updates, context);
     });
   }
@@ -675,12 +675,12 @@ ${JSON.stringify(initValues, null, 2)}`);
 
     if (this.#isOwner) {
       return new Promise((resolve, reject) => {
-        const reqId = this[kSharedStatePromiseStore].add(resolve, reject, 'delete-request');
+        const reqId = this[kSharedStatePromiseStore].add(resolve, reject, 'SharedState#delete');
         this.#client.transport.emit(`${DELETE_REQUEST}-${this.#id}-${this.#remoteId}`, reqId);
       });
     } else {
       return new Promise((resolve, reject) => {
-        const reqId = this[kSharedStatePromiseStore].add(resolve, reject, 'detach-request');
+        const reqId = this[kSharedStatePromiseStore].add(resolve, reject, 'SharedState#detach');
         this.#client.transport.emit(`${DETACH_REQUEST}-${this.#id}-${this.#remoteId}`, reqId);
       });
     }

src/common/shared-state-types.js

@@ -65,6 +65,10 @@
  *   latency on the client.
  *   If for some reason the value is overriden server-side (e.g. in an `updateHook`)
  *   the listeners will be called again when the "real" value is received.
+ * @property {boolean} [local=false] - When set to true, the parameter is never
+ *   propagated on the network (hence it is no longer a shared parameter :). This
+ *   is usefull to declare some common parameter (e.g. some interface state) that
+ *   don't need to be shared but to stay in the shared state API paradigm.
  * @property {number} [min=-Number.MIN_VALUE] - Minimum value of the parameter. Only applies
  *   for `integer` and `float` types.
  * @property {number} [max=Number.MAX_VALUE] - Maximum value of the parameter. Only applies

tests/states/schema-options.spec.js

@@ -504,7 +504,7 @@ describe('# SharedState - schema options', () => {
       await server.stop();
     });
 
-    it('[local=true]  mixed with regular param', async () => {
+    it('[local=true] mixed with regular param', async () => {
       const localConfig = structuredClone(config);
       localConfig.env.port = 8082;
       const server = new Server(localConfig);