package vue-jsoo

You can search for identifiers within the package.

in-package search v0.2.0

package vue-jsoo

vue-jsoo
- Library vue-jsoo
  - Vue_js
    
    Make
    
    SPA
    
    Root
- Library vue-jsoo.chartjs
  - Vue_chartjs
    
    mixins
    
    vue_charts
- Library vue-jsoo.component
  - Vue_component
    
    Internal
    
    prop_object_js
    
    component_arg
    
    vue_object
    
    Tables_S
    
    Tables
    
    Make
- Library vue-jsoo.mjs
  - Mjs
    
    Table
    
    unit_promise
    
    Async
- Library vue-jsoo.router
  - Vue_router
    
    Internal
    
    push_args
    
    route
    
    name
    
    router_args
    
    router
    
    Tables_S
    
    Tables
- Library vue-jsoo.vuex
  - Vuex
    
    Internal
    
    mutation_js
    
    action_input_js
    
    action_input_module
    
    cs_options_base
    
    dynamic_cs_options
    
    cs_options
    
    root_options
    
    instance_js
    
    vuex
    
    Map
    
    Tables_S
    
    Tables
    
    Make_S
    
    Make
    
    Module_S
    
    Module
- Sources
  - vue-jsoo
    
    vue_js.ml
  - vue-jsoo.chartjs
    
    vue_chartjs.ml
  - vue-jsoo.component
    
    vue_component.ml
  - vue-jsoo.mjs
    
    mjs.ml
  - vue-jsoo.router
    
    vue_router.ml
  - vue-jsoo.vuex
    
    vuex.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Vuex`Source

Sourcetype 'state action_input = {

state : 'state Mjs.t;
getters : ('state Mjs.t -> ('state Mjs.t -> Mjs.any) Mjs.table -> Mjs.any) Mjs.table;
commit : ?payload:Mjs.any -> string -> unit;
dispatch : ?payload:Mjs.any -> string -> Mjs.unit_promise Mjs.t;
root_state : Mjs.any option;
root_getters : (Mjs.any -> (Mjs.any -> Mjs.any) Mjs.table -> Mjs.any) Mjs.table option;

}

input for actions

Sourcetype 'payload mutation = {

name : string;
payload : 'payload;

}

mutation type for subscribe

Sourcemodule Internal : sig ... end

internal JS module

Sourcetype 'state options = 'state Internal.options = {

o_state : 'state Mjs.t;
o_getters : ('state Mjs.t -> Mjs.any) Mjs.table_cons;
mutations : ('state Mjs.t -> Mjs.any -> unit) Mjs.table_cons;
actions : ('state action_input -> Mjs.any -> unit) Mjs.table_cons;
plugins : Mjs.any list option;
strict : bool option;
devtools : bool option;
modules : Mjs.top Internal.dynamic_cs_options Mjs.t Mjs.table_cons;
namespaced : bool option;

}

store constructor options

Sourcetype 'state store = 'state Internal.instance_js Mjs.t

JS store object

Sourcetype 'state module_obj = 'state Internal.dynamic_cs_options Mjs.t

JS module object

Sourceval empty : 'state Mjs.t -> 'state options

empty constructor options

Sourceval make : 'state options -> 'state store

main make store function

Sourceval make_module : 'state options -> 'state module_obj

make module store function

Sourceval state : 'state store -> 'state Mjs.t

get state of store

Sourceval get : 'state store -> string -> Mjs.any

get value of one of the getters

Sourceval commit : ?payload:Mjs.any -> ?root:bool -> 'state store -> string -> unit

commit to the state of the store

Source

val dispatch : 
  ?payload:Mjs.any ->
  ?root:bool ->
  'state store ->
  string ->
  (Mjs.unit_promise Mjs.t -> 'async) ->
  'async

dispatch to the state of the store

Sourceval replace_state : 'state store -> 'state Mjs.t -> unit

replace the state of the store

Sourceval subscribe : 'state store -> ('a mutation -> 'state Mjs.t -> unit) -> unit

hook for mutation subscription

Source

val subscribe_action : 
  'state store ->
  ('a mutation -> 'state Mjs.t -> unit) ->
  unit

hook for action subscription

Sourceval register_module : 'state store -> string -> Mjs.top options -> unit

Sourceval unregister_module : 'state store -> string -> unit

unregister a module of the store

Sourceval has_module : 'state store -> string -> bool

module existence

Sourceval hot_update : 'state store -> 'a -> unit

Sourcemodule Map : sig ... end

Binding helpers

Sourcemodule type Tables_S = sig ... end

Sourcemodule Tables (S : sig ... end) : Tables_S with type state = S.state

Sourcemodule type Make_S = sig ... end

Sourcemodule Make (S : sig ... end) : Make_S with type state = S.state

Sourcemodule type Module_S = sig ... end

Sourcemodule Module (S : sig ... end) : Module_S with type state = S.state

package vue-jsoo

Module VuexSource

Module `Vuex`Source