jssm 5.65.3 → 5.65.7

package/jssm.d.ts

@@ -82,13 +82,15 @@ declare function arrow_right_kind(arrow: JssmArrow): JssmArrowKind;
  *  operator `sm`, and mostly falls back to `.from` when needing to parse
  *  strings dynamically instead of from template literals.
  *
+ *  Operator {@link sm}:
+ *
  *  ```typescript
  *  import { sm } from './jssm';
  *
  *  const switch = sm`on <=> off;`;
  *  ```
  *
- *  &hellip; or &hellip;
+ *  Method {@link from}:
  *
  *  ```typescript
  *  import * as jssm from './jssm';
@@ -131,13 +133,15 @@ declare function wrap_parse(input: string, options?: Object): any;
  *  operator `sm`, and mostly falls back to `.from` when needing to parse
  *  strings dynamically instead of from template literals.
  *
+ *  Operator {@link sm}:
+ *
  *  ```typescript
  *  import { sm } from './jssm';
  *
  *  const switch = sm`on <=> off;`;
  *  ```
  *
- *  &hellip; or &hellip;
+ *  Method {@link from}:
  *
  *  ```typescript
  *  import * as jssm from './jssm';
@@ -210,6 +214,21 @@ declare class Machine<mDT> {
     _any_transition_hook: HookHandler | undefined;
     constructor({ start_states, complete, transitions, machine_author, machine_comment, machine_contributor, machine_definition, machine_language, machine_license, machine_name, machine_version, state_declaration, fsl_version, dot_preamble, arrange_declaration, arrange_start_declaration, arrange_end_declaration, theme, flow, graph_layout, instance_name }: JssmGenericConfig<mDT>);
     _new_state(state_config: JssmGenericState): StateType;
+    /*********
+     *
+     *  Get the current state of a machine.
+     *
+     *  ```typescript
+     *  import * as jssm from './jssm';
+     *
+     *  const switch = jssm.from('on <=> off;');
+     *  console.log( switch.state() );             // 'on'
+     *
+     *  switch.transition('off');
+     *  console.log( switch.state() );             // 'off'
+     *  ```
+     *
+     */
     state(): StateType;
     state_is_final(whichState: StateType): boolean;
     is_final(): boolean;
@@ -228,8 +247,35 @@ declare class Machine<mDT> {
     state_declarations(): Map<StateType, JssmStateDeclaration>;
     fsl_version(): string;
     machine_state(): JssmMachineInternalState<mDT>;
+    /*********
+     *
+     *  List all the states known by the machine.  Please note that the order of
+     *  these states is not guaranteed.
+     *
+     *  ```typescript
+     *  import * as jssm from './jssm';
+     *
+     *  const switch = jssm.from('on <=> off;');
+     *  console.log( switch.states() );             // ['on', 'off']
+     *  ```
+     *
+     */
     states(): Array<StateType>;
     state_for(whichState: StateType): JssmGenericState;
+    /*********
+     *
+     *  Check whether the machine knows a given state.
+     *
+     *  ```typescript
+     *  import * as jssm from './jssm';
+     *
+     *  const switch = jssm.from('on <=> off;');
+  
+     *  console.log( switch.has_state('off') );     // true
+     *  console.log( switch.has_state('dance') );   // false
+     *  ```
+     *
+     */
     has_state(whichState: StateType): boolean;
     list_edges(): Array<JssmTransition<mDT>>;
     list_named_transitions(): Map<StateType, number>;
@@ -281,6 +327,39 @@ declare class Machine<mDT> {
     instance_name(): string | undefined;
     sm(template_strings: TemplateStringsArray, ...remainder: any[]): Machine<mDT>;
 }
+/*********
+ *
+ *  Create a state machine from a template string.  This is one of the two main
+ *  paths for working with JSSM, alongside {@link from}.
+ *
+ *  Use this method when you want to work directly and conveniently with a
+ *  constant template expression.  Use `.from` when you want to pull from
+ *  dynamic strings.
+ *
+ *
+ *  ```typescript
+ *  import * as jssm from './jssm';
+ *
+ *  const switch = jssm.from('on <=> off;');
+ *  ```
+ *
+ */
 declare function sm<mDT>(template_strings: TemplateStringsArray, ...remainder: any[]): Machine<mDT>;
+/*********
+ *
+ *  Create a state machine from an implementation string.  This is one of the
+ *  two main paths for working with JSSM, alongside {@link sm}.
+ *
+ *  Use this method when you want to conveniently pull a state machine from a
+ *  string dynamically.  Use operator `sm` when you just want to work with a
+ *  template expression.
+ *
+ *  ```typescript
+ *  import * as jssm from './jssm';
+ *
+ *  const switch = jssm.from('on <=> off;');
+ *  ```
+ *
+ */
 declare function from<mDT>(MachineAsString: string, ExtraConstructorFields?: Partial<JssmGenericConfig<mDT>> | undefined): Machine<mDT>;
 export { version, transfer_state_properties, Machine, make, wrap_parse as parse, compile, sm, from, arrow_direction, arrow_left_kind, arrow_right_kind, seq, weighted_rand_select, histograph, weighted_sample_select, weighted_histo_key, shapes, gviz_shapes, named_colors };

package/jssm_util.d.ts

@@ -1,10 +1,52 @@
+/*******
+ *
+ *  Predicate for validating an array for uniqueness.  Not generally meant for
+ *  external use.
+ *
+ */
 declare function arr_uniq_p<T>(el: T, i: number, source: T[]): boolean;
 declare const array_box_if_string: (n: any) => any;
 declare const weighted_rand_select: Function;
-declare const seq: Function;
+/*******
+ *
+ *  Returns, for a non-negative integer argument `n`, the series `[0 .. n]`.
+ *
+ *  ```typescript
+ *  import { seq } from './jssm';
+ *
+ *  seq(5);  // [0, 1, 2, 3, 4]
+ *  seq(0);  // []
+ *  ```
+ *
+ */
+declare function seq(n: number): number[];
+/*******
+ *
+ *  Returns the histograph of an array as a `Map`.  Makes no attempt to cope
+ *  with deep equality; will fail for complex contents, as such.
+ *
+ *  ```typescript
+ *  import { histograph } from './jssm';
+ *
+ *  histograph( [0, 0, 1, 1, 2, 2, 1] );  // Map()
+ *  ```
+ *
+ */
 declare const histograph: Function;
 declare const weighted_sample_select: Function;
 declare const weighted_histo_key: Function;
+/*******
+ *
+ *  Internal method generating names for edges for the hook lookup map.  Not
+ *  meant for external use.
+ *
+ */
 declare const hook_name: (from: string, to: string) => string;
+/*******
+ *
+ *  Internal method generating names for actions for the hook lookup map.  Not
+ *  meant for external use.
+ *
+ */
 declare const named_hook_name: (from: string, to: string, action: string) => string;
 export { seq, arr_uniq_p, histograph, weighted_histo_key, weighted_rand_select, weighted_sample_select, array_box_if_string, hook_name, named_hook_name };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jssm",
-  "version": "5.65.3",
+  "version": "5.65.7",
   "engines": {
     "node": ">=10.0.0"
   },