Module `Vuex`Source

Sourcetype ('state, 'getters) action_input = {

state : 'state Mjs.t;
getters : 'getters Mjs.t;
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 option;

}

input for actions

Sourcetype 'payload mutation = {

name : string;
payload : 'payload;

}

mutation type for subscribe

Sourcemodule Internal : sig ... end

internal JS module

Sourcetype ('state, 'getters) options = ('state, 'getters) 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, 'getters) action_input -> Mjs.any -> unit) Mjs.table_cons;
plugins : Mjs.any list option;
strict : bool option;
devtools : bool option;
modules : (Mjs.top, Mjs.top) Internal.dynamic_cs_options Mjs.t Mjs.table_cons;
namespaced : bool option;

}

store constructor options

Sourceclass type 'state store = 'state Internal.instance_js

JS store object

Sourceclass type ['state, 'getters] module_obj = ['state, 'getters] Internal.dynamic_cs_options

JS module object

Sourceval empty : 'state Mjs.t -> ('state, 'getters) options

empty constructor options

Sourceval make : ('state, 'getters) options -> 'state store Mjs.t

main make store function

Source

val make_module : 
  ('state, 'getters) options ->
  ('state, 'getters) module_obj Mjs.t

make module store function

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

get state of store

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

get value of one of the getters

Source

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

commit to the state of the store

Source

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

dispatch to the state of the store

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

replace the state of the store

Source

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

hook for mutation subscription

Source

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

hook for action subscription

Source

val register_module : 
  'state store Mjs.t ->
  string ->
  (Mjs.top, Mjs.top) options ->
  unit

Sourceval unregister_module : 'state store Mjs.t -> string -> unit

unregister a module of the store

Sourceval has_module : 'state store Mjs.t -> string -> bool

module existence

Sourceval hot_update : 'state store Mjs.t -> 'a -> unit

Sourcemodule Map : sig ... end

Binding helpers

Sourcemodule type Tables_S = sig ... end

Source

module Tables
  (S : sig ... end) : 
  Tables_S with type state = S.state and type getters = S.getters

Sourcemodule type Make_S = sig ... end

Source

module Make
  (S : sig ... end) : 
  Make_S with type state = S.state and type getters = S.getters

Sourcemodule type Module_S = sig ... end

Source

module Module
  (S : sig ... end) : 
  Module_S with type state = S.state and type getters = S.getters

Install

Dune Dependency

Authors

Maintainers

Sources

doc/vue-jsoo.vuex/Vuex/index.html

Module `Vuex`Source

package vue-jsoo

Install

Dune Dependency

Authors

Maintainers

Sources

doc/vue-jsoo.vuex/Vuex/index.html

Module VuexSource

Module `Vuex`Source