jssm 5.64.2 → 5.65.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/jssm.d.ts CHANGED
@@ -4,9 +4,57 @@ JssmMachineInternalState, JssmParseTree, JssmStateDeclaration, JssmArrow, JssmAr
4
4
  import { seq, weighted_rand_select, weighted_sample_select, histograph, weighted_histo_key } from './jssm_util';
5
5
  import { shapes, gviz_shapes, named_colors } from './jssm_constants';
6
6
  import { version } from './version';
7
+ /*********
8
+ *
9
+ * Return the direction of an arrow - `right`, `left`, or `both`.
10
+ *
11
+ * ```typescript
12
+ * import { arrow_direction } from './jssm';
13
+ *
14
+ * arrow_direction('->'); // 'right'
15
+ * arrow_direction('<~=>'); // 'both'
16
+ * ```
17
+ *
18
+ */
7
19
  declare function arrow_direction(arrow: JssmArrow): JssmArrowDirection;
20
+ /*********
21
+ *
22
+ * Return the direction of an arrow - `right`, `left`, or `both`.
23
+ *
24
+ * ```typescript
25
+ * import { arrow_left_kind } from './jssm';
26
+ *
27
+ * arrow_left_kind('<-'); // 'legal'
28
+ * arrow_left_kind('<='); // 'main'
29
+ * arrow_left_kind('<~'); // 'forced'
30
+ * arrow_left_kind('<->'); // 'legal'
31
+ * arrow_left_kind('->'); // 'none'
32
+ * ```
33
+ *
34
+ */
8
35
  declare function arrow_left_kind(arrow: JssmArrow): JssmArrowKind;
36
+ /*********
37
+ *
38
+ * Return the direction of an arrow - `right`, `left`, or `both`.
39
+ *
40
+ * ```typescript
41
+ * import { arrow_left_kind } from './jssm';
42
+ *
43
+ * arrow_left_kind('->'); // 'legal'
44
+ * arrow_left_kind('=>'); // 'main'
45
+ * arrow_left_kind('~>'); // 'forced'
46
+ * arrow_left_kind('<->'); // 'legal'
47
+ * arrow_left_kind('<-'); // 'none'
48
+ * ```
49
+ *
50
+ */
9
51
  declare function arrow_right_kind(arrow: JssmArrow): JssmArrowKind;
52
+ /*********
53
+ *
54
+ * Internal convenience method for alting out an object as the options call.
55
+ * Not generally meant for external use.
56
+ *
57
+ */
10
58
  declare function wrap_parse(input: string, options?: Object): any;
11
59
  declare function compile<mDT>(tree: JssmParseTree): JssmGenericConfig<mDT>;
12
60
  declare function make<mDT>(plan: string): JssmGenericConfig<mDT>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "jssm",
3
- "version": "5.64.2",
3
+ "version": "5.65.2",
4
4
  "engines": {
5
5
  "node": ">=10.0.0"
6
6
  },
@@ -45,6 +45,7 @@
45
45
  "vet": "npm run eslint && npm run audit",
46
46
  "benny": "node ./src/buildjs/benchmark.js",
47
47
  "build": "npm run vet && npm run test && npm run site && npm run docs && npm run benny",
48
+ "buildnb": "npm run vet && npm run test && npm run site && npm run docs",
48
49
  "qbuild": "npm run test",
49
50
  "ci_build": "npm run vet && npm run test",
50
51
  "minify": "mv dist/es6/jssm-dot.js dist/es6/jssm-dot.nonmin.js && terser dist/es6/jssm-dot.nonmin.js > dist/es6/jssm-dot.js",