diff --git a/README.md b/README.md index 8b8aaef4..4c52a88f 100644 --- a/README.md +++ b/README.md @@ -127,13 +127,15 @@ What if the machine was lighting fast, able to do tens of millions of transition
-* What if the machine and language had extensive 100% test coverage with thousands of cases? +* What if the machine and language had [extensive 100% test coverage](https://coveralls.io/github/StoneCypher/jssm) + with [thousands of cases](https://github.com/StoneCypher/jssm/tree/main/src/ts/tests)? * What if the machine gave extensive Typescript introspection support? -* What if the machine had been around and active since ? -* What if the machine was MIT end to end? +* What if the machine had been around and active since May 2017? +* What if the machine was MIT licensed, end to end? -You just learned the basics of [Finite State Language](https://fsl.tools/), and this is a state machine for compiling, -running, and visually rendering it. +But, above all else: + +`What if it was easy?` diff --git a/docs/docs/classes/machine.html b/docs/docs/classes/machine.html index 7fc9f2ab..7034b07c 100644 --- a/docs/docs/classes/machine.html +++ b/docs/docs/classes/machine.html @@ -199,7 +199,7 @@

constructor

  • Type parameters

    @@ -227,7 +227,7 @@

    _actions

    _actions: Map<string, Map<string, number>>
    @@ -237,7 +237,7 @@

    _arrange_declaration

    _arrange_declaration: string[][]
    @@ -247,7 +247,7 @@

    _arrange_end_declaration

    _arrange_end_declaration: string[][]
    @@ -257,7 +257,7 @@

    _arrange_start_declaration

    _arrange_start_declaration: string[][]
    @@ -267,7 +267,7 @@

    _dot_preamble

    _dot_preamble: string
    @@ -277,7 +277,7 @@

    _edge_map

    _edge_map: Map<string, Map<string, number>>
    @@ -287,7 +287,7 @@

    _edges

    _edges: JssmTransition<mDT>[]
    @@ -297,7 +297,7 @@

    _flow

    _flow: FslDirection
    @@ -307,7 +307,7 @@

    Optional _fsl_version

    _fsl_version: string @@ -317,7 +317,7 @@

    _graph_layout

    _graph_layout: JssmLayout
    @@ -327,7 +327,7 @@

    Optional _machine_author<
    _machine_author: string[]
    @@ -337,7 +337,7 @@

    Optional _machine_comment
    _machine_comment: string
    @@ -347,7 +347,7 @@

    Optional _machine_contrib
    _machine_contributor: string[]
    @@ -357,7 +357,7 @@

    Optional _machine_definit
    _machine_definition: string
    @@ -367,7 +367,7 @@

    Optional _machine_languag
    _machine_language: string
    @@ -377,7 +377,7 @@

    Optional _machine_license
    _machine_license: string
    @@ -387,7 +387,7 @@

    Optional _machine_name_machine_name: string @@ -397,7 +397,7 @@

    Optional _machine_version
    _machine_version: string
    @@ -407,7 +407,7 @@

    _named_transitions

    _named_transitions: Map<string, number>
    @@ -417,7 +417,7 @@

    Optional _raw_state_
    _raw_state_declaration: Object[]
    @@ -427,7 +427,7 @@

    _reverse_action_targets

    _reverse_action_targets: Map<string, Map<string, number>>
    @@ -437,7 +437,7 @@

    _reverse_actions

    _reverse_actions: Map<string, Map<string, number>>
    @@ -447,7 +447,7 @@

    _state

    _state: string
    @@ -457,7 +457,7 @@

    _state_declarations

    _state_declarations: Map<string, JssmStateDeclaration>
    @@ -467,7 +467,7 @@

    _states

    _states: Map<string, JssmGenericState>
    @@ -477,7 +477,7 @@

    _theme

    _theme: FslTheme
    @@ -494,7 +494,7 @@

    _new_state

  • Parameters

    @@ -517,7 +517,7 @@

    action

  • Parameters

    @@ -543,7 +543,7 @@

    actions

  • Parameters

    @@ -566,7 +566,7 @@

    current_action_edge_for

  • Parameters

    @@ -589,7 +589,7 @@

    current_action_for

  • Parameters

    @@ -612,7 +612,7 @@

    dot_preamble

  • Returns string

    @@ -629,7 +629,7 @@

    flow

  • Returns FslDirection

    @@ -646,7 +646,7 @@

    force_transition

  • Parameters

    @@ -672,7 +672,7 @@

    fsl_version

  • Returns string

    @@ -689,7 +689,7 @@

    get_transition_by_state_names

  • Parameters

    @@ -715,7 +715,7 @@

    graph_layout

  • Returns string

    @@ -732,7 +732,7 @@

    has_completes

  • Returns boolean

    @@ -749,7 +749,7 @@

    has_state

  • Parameters

    @@ -772,7 +772,7 @@

    has_terminals

  • Returns boolean

    @@ -789,7 +789,7 @@

    has_unenterables

  • Returns boolean

    @@ -806,7 +806,7 @@

    is_complete

  • Returns boolean

    @@ -823,7 +823,7 @@

    is_final

  • Returns boolean

    @@ -840,7 +840,7 @@

    is_terminal

  • Returns boolean

    @@ -857,7 +857,7 @@

    is_unenterable

  • Parameters

    @@ -880,7 +880,7 @@

    list_actions

  • Returns string[]

    @@ -897,7 +897,7 @@

    list_edges

  • Returns JssmTransition<mDT>[]

    @@ -914,7 +914,7 @@

    list_entrances

  • Parameters

    @@ -937,7 +937,7 @@

    list_exit_actions

  • Parameters

    @@ -960,7 +960,7 @@

    list_exits

  • Parameters

    @@ -983,7 +983,7 @@

    list_named_transitions

  • Returns Map<string, number>

    @@ -1000,7 +1000,7 @@

    list_states_having_action

  • Parameters

    @@ -1023,7 +1023,7 @@

    list_transitions

  • Parameters

    @@ -1046,7 +1046,7 @@

    lookup_transition_for

  • Parameters

    @@ -1072,7 +1072,7 @@

    machine_author

  • Returns string[]

    @@ -1089,7 +1089,7 @@

    machine_comment

  • Returns string

    @@ -1106,7 +1106,7 @@

    machine_contributor

  • Returns string[]

    @@ -1123,7 +1123,7 @@

    machine_definition

  • Returns string

    @@ -1140,7 +1140,7 @@

    machine_language

  • Returns string

    @@ -1157,7 +1157,7 @@

    machine_license

  • Returns string

    @@ -1174,7 +1174,7 @@

    machine_name

  • Returns string

    @@ -1191,7 +1191,7 @@

    machine_state

  • Returns JssmMachineInternalState<mDT>

    @@ -1208,7 +1208,7 @@

    machine_version

  • Returns string

    @@ -1225,7 +1225,7 @@

    probabilistic_histo_walk

  • Parameters

    @@ -1248,7 +1248,7 @@

    probabilistic_transition

  • Returns boolean

    @@ -1265,7 +1265,7 @@

    probabilistic_walk

  • Parameters

    @@ -1288,7 +1288,7 @@

    probable_action_exits

  • Parameters

    @@ -1311,7 +1311,7 @@

    probable_exits_for

  • Parameters

    @@ -1334,7 +1334,7 @@

    raw_state_declarations

  • Returns Object[]

    @@ -1351,7 +1351,7 @@

    sm

  • Parameters

    @@ -1377,7 +1377,7 @@

    state

  • Returns string

    @@ -1394,7 +1394,7 @@

    state_declaration

  • Parameters

    @@ -1417,7 +1417,7 @@

    state_declarations

  • Returns Map<string, JssmStateDeclaration>

    @@ -1434,7 +1434,7 @@

    state_for

  • Parameters

    @@ -1457,7 +1457,7 @@

    state_is_complete

  • Parameters

    @@ -1480,7 +1480,7 @@

    state_is_final

  • Parameters

    @@ -1503,7 +1503,7 @@

    state_is_terminal

  • Parameters

    @@ -1526,7 +1526,7 @@

    states

  • Returns string[]

    @@ -1543,7 +1543,7 @@

    theme

  • Returns FslTheme

    @@ -1560,7 +1560,7 @@

    transition

  • Parameters

    @@ -1586,7 +1586,7 @@

    valid_action

  • Parameters

    @@ -1612,7 +1612,7 @@

    valid_force_transition

  • Parameters

    @@ -1638,7 +1638,7 @@

    valid_transition

  • Parameters

    diff --git a/docs/docs/index.html b/docs/docs/index.html index 5824922a..a0d331e8 100644 --- a/docs/docs/index.html +++ b/docs/docs/index.html @@ -149,13 +149,14 @@

    jssm


    -

    You just learned the basics of Finite State Language, and this is a state machine for compiling, - running, and visually rendering it.

    +

    But, above all else:

    +

    What if it was easy?



    Introducing JSSM

    diff --git a/docs/docs/modules.html b/docs/docs/modules.html index 38a7f062..4cc3298f 100644 --- a/docs/docs/modules.html +++ b/docs/docs/modules.html @@ -102,7 +102,7 @@

    Const histograph

    histograph: Function = ...
    @@ -112,7 +112,7 @@

    Const seq

    seq: Function = ...
    @@ -122,7 +122,7 @@

    Const version

    version: string = "5.35.3"
    @@ -132,7 +132,7 @@

    Const weighted_histo_ke
    weighted_histo_key: Function = ...
    @@ -142,7 +142,7 @@

    Const weighted_rand_sel
    weighted_rand_select: Function = ...
    @@ -152,7 +152,7 @@

    Const weighted_sample_s
    weighted_sample_select: Function = ...
    @@ -169,7 +169,7 @@

    arrow_direction

  • Parameters

    @@ -192,7 +192,7 @@

    arrow_left_kind

  • Parameters

    @@ -215,7 +215,7 @@

    arrow_right_kind

  • Parameters

    @@ -238,7 +238,7 @@

    compile

  • Type parameters

    @@ -267,7 +267,7 @@

    make

  • Type parameters

    @@ -296,7 +296,7 @@

    parse

  • Parameters

    @@ -322,7 +322,7 @@

    sm

  • Type parameters

    @@ -354,7 +354,7 @@

    transfer_state_properties

  • Parameters

    diff --git a/package-lock.json b/package-lock.json index 38bccb5d..e6fcb1fc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "jssm", - "version": "5.35.0", + "version": "5.35.3", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -9352,6 +9352,16 @@ "integrity": "sha512-EZiXBUpogsYWe0dLgy47J8yRZCd+HAn9woGzO28XJxxSCSwZRYGKeQiw1KjyIcm3cBtLWUXiPD5+Bgx24GgZjg==", "dev": true }, + "typedoc-neo-theme": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/typedoc-neo-theme/-/typedoc-neo-theme-1.1.0.tgz", + "integrity": "sha512-4VBGSJEd01Bi9ddHb9iMBD9vSR+F6PyfZUWu5fKinaDUJ84rd4ux05joGWWLHhBSgGeLnVG22EE8Jo8xO102Ng==", + "dev": true, + "requires": { + "lunr": "^2.3.8", + "typedoc": "~0.20.13" + } + }, "typescript": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.1.3.tgz", diff --git a/package.json b/package.json index f8e35995..ee99bd95 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "jssm", - "version": "5.35.3", + "version": "5.35.4", "engines": { "node": ">=10.0.0" }, @@ -44,7 +44,7 @@ "min_iife": "mv dist/jssm.es5.iife.js dist/jssm.es5.iife.nonmin.js && terser dist/jssm.es5.iife.nonmin.js > dist/jssm.es5.iife.js", "min_cjs": "mv dist/jssm.es5.cjs.js dist/jssm.es5.cjs.nonmin.js && terser dist/jssm.es5.cjs.nonmin.js > dist/jssm.es5.cjs.js", "site": "cp src/site/* docs/", - "docs": "typedoc src/ts/jssm.ts --out docs/docs", + "docs": "typedoc src/ts/jssm.ts --out docs/docs --theme ./node_modules/typedoc-neo-theme/bin/default", "changelog": "rm -f CHANGELOG.md && changelog-maker -a > CHANGELOG.md" }, "repository": { @@ -112,6 +112,7 @@ "text_audit": "^0.9.3", "ts-jest": "^26.4.4", "typedoc": "^0.20.16", + "typedoc-neo-theme": "^1.1.0", "typescript": "^4.1.3", "viz.js": "^1.7.1" },