Options
All
  • Public
  • Public/Protected
  • All
Menu

Module jssm_types

Index

Namespaces

Type Aliases

Variables

Type Aliases

FslDirection

FslDirection: typeof FslDirections[number]

FslTheme

FslTheme: typeof FslThemes[number]

HookComplexResult

HookComplexResult<mDT>: { data?: mDT; next_data?: mDT; pass: boolean; state?: StateType }

Type Parameters

  • mDT

Type declaration

  • Optional data?: mDT
  • Optional next_data?: mDT
  • pass: boolean
  • Optional state?: StateType

HookContext

HookContext<mDT>: { data: mDT; next_data: mDT }

Type Parameters

  • mDT

Type declaration

  • data: mDT
  • next_data: mDT

HookDescription

HookDescription<mDT>: BasicHookDescription<mDT> | HookDescriptionWithAction<mDT> | GlobalActionHook<mDT> | AnyActionHook<mDT> | StandardTransitionHook<mDT> | MainTransitionHook<mDT> | ForcedTransitionHook<mDT> | AnyTransitionHook<mDT> | EntryHook<mDT> | ExitHook<mDT> | AfterHook<mDT> | PostBasicHookDescription<mDT> | PostHookDescriptionWithAction<mDT> | PostGlobalActionHook<mDT> | PostAnyActionHook<mDT> | PostStandardTransitionHook<mDT> | PostMainTransitionHook<mDT> | PostForcedTransitionHook<mDT> | PostAnyTransitionHook<mDT> | PostEntryHook<mDT> | PostExitHook<mDT>

Type Parameters

  • mDT

HookHandler

HookHandler<mDT>: ((hook_context: HookContext<mDT>) => HookResult<mDT>)

Type Parameters

  • mDT

Type declaration

HookResult

HookResult<mDT>: boolean | undefined | void | HookComplexResult<mDT>

Type Parameters

  • mDT

JssmAllowsOverride

JssmAllowsOverride: boolean | undefined

JssmArrow

JssmArrow: "->" | "<-" | "<->" | "<=->" | "<~->" | "=>" | "<=" | "<=>" | "<-=>" | "<~=>" | "~>" | "<~" | "<~>" | "<-~>" | "<=~>"

JssmArrowDirection

JssmArrowDirection: "left" | "right" | "both"

JssmArrowKind

JssmArrowKind: "none" | "legal" | "main" | "forced"

JssmBaseTheme

JssmBaseTheme: { action: undefined; active: JssmStateConfig; active_end: JssmStateConfig; active_hooked: JssmStateConfig; active_start: JssmStateConfig; active_terminal: JssmStateConfig; end: JssmStateConfig; forced: undefined; graph: undefined; hooked: JssmStateConfig; legal: undefined; main: undefined; name: string; start: JssmStateConfig; state: JssmStateConfig; terminal: JssmStateConfig; title: undefined }

Type declaration

JssmColor

JssmColor: string

JssmCompileRule

JssmCompileRule<StateType>: { agg_as: string; val: any }

Type Parameters

  • StateType

Type declaration

  • agg_as: string
  • val: any

JssmCompileSe

JssmCompileSe<StateType, mDT>: { kind: JssmArrow; l_action?: StateType; l_after?: number; l_probability: number; r_action?: StateType; r_after?: number; r_probability: number; se?: JssmCompileSe<StateType, mDT>; to: StateType }

Type Parameters

  • StateType

  • mDT

Type declaration

  • kind: JssmArrow
  • Optional l_action?: StateType
  • Optional l_after?: number
  • l_probability: number
  • Optional r_action?: StateType
  • Optional r_after?: number
  • r_probability: number
  • Optional se?: JssmCompileSe<StateType, mDT>
  • to: StateType

JssmCompileSeStart

JssmCompileSeStart<StateType, DataType>: { default_value?: any; from: StateType; key: string; name?: string; required?: boolean; se: JssmCompileSe<StateType, DataType>; state?: string; value?: string | number }

Type Parameters

  • StateType

  • DataType

Type declaration

  • Optional default_value?: any
  • from: StateType
  • key: string
  • Optional name?: string
  • Optional required?: boolean
  • se: JssmCompileSe<StateType, DataType>
  • Optional state?: string
  • Optional value?: string | number

JssmErrorExtendedInfo

JssmErrorExtendedInfo: { requested_state?: StateType }

Type declaration

JssmGenericConfig

JssmGenericConfig<StateType, DataType>: { actions?: JssmPermittedOpt; allow_force?: false; allow_islands?: false; allows_override?: JssmAllowsOverride; arrange_declaration?: StateType[][]; arrange_end_declaration?: StateType[][]; arrange_start_declaration?: StateType[][]; auto_api?: boolean | string; check?: JssmStatePermitterMaybeArray<DataType>; complete?: StateType[]; config_allows_override?: JssmAllowsOverride; data?: DataType; default_active_state_config?: JssmStateStyleKeyList; default_end_state_config?: JssmStateStyleKeyList; default_hooked_state_config?: JssmStateStyleKeyList; default_start_state_config?: JssmStateStyleKeyList; default_state_config?: JssmStateStyleKeyList; default_terminal_state_config?: JssmStateStyleKeyList; dot_preamble?: string; end_states?: StateType[]; flow?: FslDirection; fsl_version?: string; graph_layout?: JssmLayout; history?: number; initial_state?: StateType; instance_name?: string; machine_author?: string | string[]; machine_comment?: string; machine_contributor?: string | string[]; machine_definition?: string; machine_language?: string; machine_license?: string; machine_name?: string; machine_version?: string; max_exits?: number; min_exits?: number; name?: string; nodes?: StateType[]; property_definition?: JssmPropertyDefinition[]; rng_seed?: number; simplify_bidi?: boolean; start_states: StateType[]; start_states_no_enforce?: boolean; state_declaration?: <internal>.Object[]; state_property?: JssmPropertyDefinition[]; theme?: FslTheme[]; transitions: JssmTransitions<StateType, DataType>; clear_timeout_source?: any; time_source?: any; timeout_source?: any }

Type Parameters

  • StateType

  • DataType

Type declaration

  • Optional actions?: JssmPermittedOpt
  • Optional allow_force?: false
  • Optional allow_islands?: false
  • Optional allows_override?: JssmAllowsOverride
  • Optional arrange_declaration?: StateType[][]
  • Optional arrange_end_declaration?: StateType[][]
  • Optional arrange_start_declaration?: StateType[][]
  • Optional auto_api?: boolean | string
  • Optional check?: JssmStatePermitterMaybeArray<DataType>
  • Optional complete?: StateType[]
  • Optional config_allows_override?: JssmAllowsOverride
  • Optional data?: DataType
  • Optional default_active_state_config?: JssmStateStyleKeyList
  • Optional default_end_state_config?: JssmStateStyleKeyList
  • Optional default_hooked_state_config?: JssmStateStyleKeyList
  • Optional default_start_state_config?: JssmStateStyleKeyList
  • Optional default_state_config?: JssmStateStyleKeyList
  • Optional default_terminal_state_config?: JssmStateStyleKeyList
  • Optional dot_preamble?: string
  • Optional end_states?: StateType[]
  • Optional flow?: FslDirection
  • Optional fsl_version?: string
  • Optional graph_layout?: JssmLayout
  • Optional history?: number
  • Optional initial_state?: StateType
  • Optional instance_name?: string
  • Optional machine_author?: string | string[]
  • Optional machine_comment?: string
  • Optional machine_contributor?: string | string[]
  • Optional machine_definition?: string
  • Optional machine_language?: string
  • Optional machine_license?: string
  • Optional machine_name?: string
  • Optional machine_version?: string
  • Optional max_exits?: number
  • Optional min_exits?: number
  • Optional name?: string
  • Optional nodes?: StateType[]
  • Optional property_definition?: JssmPropertyDefinition[]
  • Optional rng_seed?: number
  • Optional simplify_bidi?: boolean
  • start_states: StateType[]
  • Optional start_states_no_enforce?: boolean
  • Optional state_declaration?: <internal>.Object[]
  • Optional state_property?: JssmPropertyDefinition[]
  • Optional theme?: FslTheme[]
  • transitions: JssmTransitions<StateType, DataType>
  • clear_timeout_source?:function
    • clear_timeout_source(number: any): void
  • time_source?:function
    • time_source(): number
  • timeout_source?:function
    • timeout_source(Function: any, number: any): number

JssmGenericMachine

JssmGenericMachine<DataType>: { allow_empty?: boolean; allow_force?: boolean; allow_islands?: boolean; check?: JssmStatePermitterMaybeArray<DataType>; data?: DataType; keep_history?: boolean | number; max_transitions?: number; min_transitions?: number; name?: string; nodes?: StateType[]; state: StateType; transitions: JssmTransitions<StateType, DataType> }

Type Parameters

  • DataType

Type declaration

  • Optional allow_empty?: boolean
  • Optional allow_force?: boolean
  • Optional allow_islands?: boolean
  • Optional check?: JssmStatePermitterMaybeArray<DataType>
  • Optional data?: DataType
  • Optional keep_history?: boolean | number
  • Optional max_transitions?: number
  • Optional min_transitions?: number
  • Optional name?: string
  • Optional nodes?: StateType[]
  • state: StateType
  • transitions: JssmTransitions<StateType, DataType>

JssmGenericState

JssmGenericState: { complete: boolean; from: StateType[]; name: StateType; to: StateType[] }

Type declaration

JssmHistory

JssmHistory<mDT>: circular_buffer<[StateType, mDT]>

Type Parameters

  • mDT

JssmLayout

JssmLayout: "dot" | "circo" | "twopi" | "fdp" | "neato"

JssmMachineInternalState

JssmMachineInternalState<DataType>: { actions: Map<StateType, Map<StateType, number>>; edge_map: Map<StateType, Map<StateType, number>>; edges: JssmTransition<StateType, DataType>[]; internal_state_impl_version: 1; named_transitions: Map<StateType, number>; reverse_actions: Map<StateType, Map<StateType, number>>; state: StateType; states: Map<StateType, JssmGenericState> }

Type Parameters

  • DataType

Type declaration

JssmParseFunctionType

JssmParseFunctionType<StateType, mDT>: ((string: any) => JssmParseTree<StateType, mDT>)

Type Parameters

  • StateType

  • mDT

Type declaration

JssmParseTree

JssmParseTree<StateType, mDT>: JssmCompileSeStart<StateType, mDT>[]

Type Parameters

  • StateType

  • mDT

JssmPermitted

JssmPermitted: "required" | "disallowed"

JssmPermittedOpt

JssmPermittedOpt: "required" | "disallowed" | "optional"

JssmPropertyDefinition

JssmPropertyDefinition: { default_value?: any; name: string; required?: boolean }

Type declaration

  • Optional default_value?: any
  • name: string
  • Optional required?: boolean

JssmResult

JssmResult: JssmSuccess | JssmFailure | JssmIncomplete

JssmRng

JssmRng: (() => number)

Type declaration

    • (): number

    • Returns number

JssmSerialization

JssmSerialization<DataType>: { comment?: string; data: DataType; history: [string, DataType][]; history_capacity: number; jssm_version: string; state: StateType; timestamp: number }

Type Parameters

  • DataType

Type declaration

  • Optional comment?: string
  • data: DataType
  • history: [string, DataType][]
  • history_capacity: number
  • jssm_version: string
  • state: StateType
  • timestamp: number

JssmShape

JssmShape: "box" | "polygon" | "ellipse" | "oval" | "circle" | "point" | "egg" | "triangle" | "plaintext" | "plain" | "diamond" | "trapezium" | "parallelogram" | "house" | "pentagon" | "hexagon" | "septagon" | "octagon" | "doublecircle" | "doubleoctagon" | "tripleoctagon" | "invtriangle" | "invtrapezium" | "invhouse" | "Mdiamond" | "Msquare" | "Mcircle" | "rect" | "rectangle" | "square" | "star" | "none" | "underline" | "cylinder" | "note" | "tab" | "folder" | "box3d" | "component" | "promoter" | "cds" | "terminator" | "utr" | "primersite" | "restrictionsite" | "fivepoverhang" | "threepoverhang" | "noverhang" | "assembly" | "signature" | "insulator" | "ribosite" | "rnastab" | "proteasesite" | "proteinstab" | "rpromoter" | "rarrow" | "larrow" | "lpromoter" | "record"

A type teaching Typescript the various supported shapes for nodes, mostly inherited from GraphViz

JssmStateConfig

JssmStateConfig: Partial<JssmStateDeclaration>

JssmStateDeclaration

JssmStateDeclaration: { backgroundColor?: JssmColor; borderColor?: JssmColor; color?: JssmColor; corners?: JssmCorner; declarations: JssmStateDeclarationRule[]; lineStyle?: JssmLineStyle; property?: { name: string; value: unknown }; shape?: JssmShape; state: StateType; stateLabel?: string; textColor?: JssmColor }

Type declaration

JssmStateDeclarationRule

JssmStateDeclarationRule: { key: string; name?: string; value: any }

Type declaration

  • key: string
  • Optional name?: string
  • value: any

JssmStateStyleKey

JssmStateStyleKey: JssmStateStyleShape | JssmStateStyleColor | JssmStateStyleTextColor | JssmStateStyleCorners | JssmStateStyleLineStyle | JssmStateStyleBackgroundColor | JssmStateStyleStateLabel | JssmStateStyleBorderColor

JssmStateStyleKeyList

JssmStateStyleKeyList: JssmStateStyleKey[]

JssmTheme

JssmTheme: Partial<JssmBaseTheme>

JssmTransition

JssmTransition<StateType, DataType>: { action?: StateType; after_time?: number; check?: JssmTransitionPermitterMaybeArray<DataType>; forced_only: boolean; from: StateType; kind: JssmArrowKind; main_path: boolean; name?: StateType; probability?: number; se?: JssmCompileSe<StateType, DataType>; to: StateType }

Type Parameters

  • StateType

  • DataType

Type declaration

  • Optional action?: StateType
  • Optional after_time?: number
  • Optional check?: JssmTransitionPermitterMaybeArray<DataType>
  • forced_only: boolean
  • from: StateType
  • kind: JssmArrowKind
  • main_path: boolean
  • Optional name?: StateType
  • Optional probability?: number
  • Optional se?: JssmCompileSe<StateType, DataType>
  • to: StateType

JssmTransitionList

JssmTransitionList: { entrances: StateType[]; exits: StateType[] }

Type declaration

JssmTransitionRule

JssmTransitionRule: StateType | JssmTransitionCycle

JssmTransitions

JssmTransitions<StateType, DataType>: JssmTransition<StateType, DataType>[]

Type Parameters

  • StateType

  • DataType

Variables

Const FslDirections

FslDirections: readonly ["up", "right", "down", "left"] = ...

Const FslThemes

FslThemes: readonly ["default", "ocean", "modern", "plain", "bold"] = ...

Generated using TypeDoc