Merge pull request #540 from StoneCypher/ReintroduceDisplayText

Reintroduce display text, lost in a bad merge

README.md

@@ -18,7 +18,7 @@ Please edit the file it's derived from, instead: `./src/md/readme_base.md`
 
 
 
-* Generated for version 5.85.2 at 9/12/2022, 9:59:10 AM
+* Generated for version 5.85.3 at 9/12/2022, 11:23:15 AM
 
 -->
 # jssm
@@ -29,7 +29,7 @@ share online.  Easy to embed.
 
 Readable, useful state machines as one-liner strings.
 
-***4,844 tests*** run 5,735 times.  4,835 specs with 100.0% coverage, 9 fuzz tests with 13.0% coverage.  With 2,693 lines, that's about 1.8 tests per line, or 2.1 generated tests per line.
+***4,847 tests*** run 5,738 times.  4,838 specs with 100.0% coverage, 9 fuzz tests with 13.0% coverage.  With 2,696 lines, that's about 1.8 tests per line, or 2.1 generated tests per line.
 
 ***Meet your new state machine library.***
 

dist/es6/jssm.d.ts

@@ -303,12 +303,38 @@ declare class Machine<mDT> {
      *
      *  const lswitch = jssm.from('a -> b; state a: { label: "Foo!"; };');
      *  console.log( lswitch.label_for('a') );              // 'Foo!'
+     *  console.log( lswitch.label_for('b') );              // undefined
      *  ```
      *
+     *  See also {@link display_text}.
+     *
      *  @typeparam mDT The type of the machine data member; usually omitted
      *
      */
     label_for(state: StateType): string;
+    /*********
+     *
+     *  Get whatever the node should show as text.
+     *
+     *  Currently, this means to get the label for a given state, if any;
+     *  otherwise to return the node's name.  However, this definition is expected
+     *  to grow with time, and it is currently considered ill-advised to manually
+     *  parse this text.
+     *
+     *  See also {@link label_for}.
+     *
+     *  ```typescript
+     *  import * as jssm from 'jssm';
+     *
+     *  const lswitch = jssm.from('a -> b; state a: { label: "Foo!"; };');
+     *  console.log( lswitch.display_text('a') );              // 'Foo!'
+     *  console.log( lswitch.display_text('b') );              // 'b'
+     *  ```
+     *
+     *  @typeparam mDT The type of the machine data member; usually omitted
+     *
+     */
+    display_text(state: StateType): string;
     /*********
      *
      *  Get the current data of a machine.

dist/es6/jssm.js

@@ -946,14 +946,43 @@ class Machine {
      *
      *  const lswitch = jssm.from('a -> b; state a: { label: "Foo!"; };');
      *  console.log( lswitch.label_for('a') );              // 'Foo!'
+     *  console.log( lswitch.label_for('b') );              // undefined
      *  ```
      *
+     *  See also {@link display_text}.
+     *
      *  @typeparam mDT The type of the machine data member; usually omitted
      *
      */
     label_for(state) {
         return this._state_labels.get(state);
     }
+    /*********
+     *
+     *  Get whatever the node should show as text.
+     *
+     *  Currently, this means to get the label for a given state, if any;
+     *  otherwise to return the node's name.  However, this definition is expected
+     *  to grow with time, and it is currently considered ill-advised to manually
+     *  parse this text.
+     *
+     *  See also {@link label_for}.
+     *
+     *  ```typescript
+     *  import * as jssm from 'jssm';
+     *
+     *  const lswitch = jssm.from('a -> b; state a: { label: "Foo!"; };');
+     *  console.log( lswitch.display_text('a') );              // 'Foo!'
+     *  console.log( lswitch.display_text('b') );              // 'b'
+     *  ```
+     *
+     *  @typeparam mDT The type of the machine data member; usually omitted
+     *
+     */
+    display_text(state) {
+        var _a;
+        return (_a = this._state_labels.get(state)) !== null && _a !== void 0 ? _a : state;
+    }
     /*********
      *
      *  Get the current data of a machine.

dist/es6/version.js

@@ -1,2 +1,2 @@
-const version = "5.85.2";
+const version = "5.85.3";
 export { version };

dist/jssm.es5.cjs.nonmin.js

@@ -19301,7 +19301,7 @@ function peg$parse(input, options) {
     }
 }
 
-const version = "5.85.2";
+const version = "5.85.3";
 
 // whargarbl lots of these return arrays could/should be sets
 const theme_mapping = new Map();
@@ -20235,14 +20235,43 @@ class Machine {
      *
      *  const lswitch = jssm.from('a -> b; state a: { label: "Foo!"; };');
      *  console.log( lswitch.label_for('a') );              // 'Foo!'
+     *  console.log( lswitch.label_for('b') );              // undefined
      *  ```
      *
+     *  See also {@link display_text}.
+     *
      *  @typeparam mDT The type of the machine data member; usually omitted
      *
      */
     label_for(state) {
         return this._state_labels.get(state);
     }
+    /*********
+     *
+     *  Get whatever the node should show as text.
+     *
+     *  Currently, this means to get the label for a given state, if any;
+     *  otherwise to return the node's name.  However, this definition is expected
+     *  to grow with time, and it is currently considered ill-advised to manually
+     *  parse this text.
+     *
+     *  See also {@link label_for}.
+     *
+     *  ```typescript
+     *  import * as jssm from 'jssm';
+     *
+     *  const lswitch = jssm.from('a -> b; state a: { label: "Foo!"; };');
+     *  console.log( lswitch.display_text('a') );              // 'Foo!'
+     *  console.log( lswitch.display_text('b') );              // 'b'
+     *  ```
+     *
+     *  @typeparam mDT The type of the machine data member; usually omitted
+     *
+     */
+    display_text(state) {
+        var _a;
+        return (_a = this._state_labels.get(state)) !== null && _a !== void 0 ? _a : state;
+    }
     /*********
      *
      *  Get the current data of a machine.

dist/jssm.es5.iife.nonmin.js

@@ -19300,7 +19300,7 @@ var jssm = (function (exports) {
       }
   }
 
-  const version = "5.85.2";
+  const version = "5.85.3";
 
   // whargarbl lots of these return arrays could/should be sets
   const theme_mapping = new Map();
@@ -20234,14 +20234,43 @@ var jssm = (function (exports) {
        *
        *  const lswitch = jssm.from('a -> b; state a: { label: "Foo!"; };');
        *  console.log( lswitch.label_for('a') );              // 'Foo!'
+       *  console.log( lswitch.label_for('b') );              // undefined
        *  ```
        *
+       *  See also {@link display_text}.
+       *
        *  @typeparam mDT The type of the machine data member; usually omitted
        *
        */
       label_for(state) {
           return this._state_labels.get(state);
       }
+      /*********
+       *
+       *  Get whatever the node should show as text.
+       *
+       *  Currently, this means to get the label for a given state, if any;
+       *  otherwise to return the node's name.  However, this definition is expected
+       *  to grow with time, and it is currently considered ill-advised to manually
+       *  parse this text.
+       *
+       *  See also {@link label_for}.
+       *
+       *  ```typescript
+       *  import * as jssm from 'jssm';
+       *
+       *  const lswitch = jssm.from('a -> b; state a: { label: "Foo!"; };');
+       *  console.log( lswitch.display_text('a') );              // 'Foo!'
+       *  console.log( lswitch.display_text('b') );              // 'b'
+       *  ```
+       *
+       *  @typeparam mDT The type of the machine data member; usually omitted
+       *
+       */
+      display_text(state) {
+          var _a;
+          return (_a = this._state_labels.get(state)) !== null && _a !== void 0 ? _a : state;
+      }
       /*********
        *
        *  Get the current data of a machine.