API リファレンス

Vuex.Store

import Vuex from 'vuex'

const store = new Vuex.Store({ ...options })

Vuex.Store コンストラクタオプション

state
- 型: Object
ストアのためのルートステートオブジェクトです。

詳細
mutations
- 型: { [type: string]: Function }
ストアにミューテーションを登録します。ハンドラ関数は第一引数に state を常に受け取り(モジュール内で定義されていれば、モジュールのローカルステートを受け取り)、指定されていれば第二引数に payload を受け取ります。

詳細

actions

型: { [type: string]: Function }

ストアにアクションを登録します。ハンドラ関数は次のプロパティを持つ context オブジェクトを受け取ります。:

{
  state,     // store.state と同じか、モジュール内にあればローカルステート
  rootState, // store.state と同じ。ただしモジュール内に限る
  commit,    // store.commit と同じ
  dispatch,  // store.dispatch と同じ
  getters    // store.getters と同じ
}

詳細

getters
- type: { [key: string]: Function }
ストアにゲッターを登録します. ゲッター関数は次の引数を受け取ります:
```
state,     // モジュール内で定義されていればモジュールのローカルステート
getters,   // store.getters と同じ
rootState  // store.state と同じ
```
登録されたゲッターは store.getters 上に公開されます。

詳細
modules
- 型: Object
サブモジュールを含む次のような形式のオブジェクトはストアにマージされます。
```
{
  key: {
    state,
    mutations
    actions?,
    getters?,
    modules?
    
  },
  ...
}
```
各モジュールは、ルートオプションに似た state と mutations を含むことができます。モジュールの状態は、モジュールのキーを使って、ストアのルートステートに結合されます。モジュールのミューテーションとゲッターは、第一引数としてルートステートの代わりに、モジュールのローカルステートだけを受け取り、モジュールのアクションの context.state もローカルステートを指すようになります。

詳細
plugins
- 型: Array<Function>
プラグイン関数の配列は、ストアに適用されます。このプラグインは、ストアだけを引数として受け取り、外部への永続化、ロギング、デバッギングのために、ミューテーションを監視するか、または、 websocket や observable のような外から渡されるデータのためにミューテーションをディスパッチします。

詳細
strict
- 型: Boolean
- デフォルト: false
Vuex ストアを厳格モードにします。厳格モードでは、ミューテーションハンドラ以外で、 Vuex の状態の変更を行うと、エラーが投げられます。

詳細

Vuex.Store インスタンスプロパティ

state
- type: Object
ルートステート、読み取り専用です。
getters
- type: Object
登録されているゲッターを公開します。読み取り専用です。

Vuex.Store インスタンスメソッド

commit(type: string, payload?: any) | commit(mutation: Object)

ミューテーションをコミットします。詳細

dispatch(type: string, payload?: any) | dispatch(action: Object)

アクションをディスパッチします。すべてのトリガーされたアクションハンドラを解決するPromiseを返します。詳細

replaceState(state: Object)

ストアのルートステートを置き換えます。これは、ステートのハイドレーションやタイムトラベルのためだけに利用すべきです。

watch(getter: Function, cb: Function, options?: Object)

リアクティブにゲッター関数の返す値を監視します。値が変わった場合は、コールバックを呼びます。ゲッターはストアの状態のみを引数として受け取ります。 Vue のvm.$watchメソッドと同じオプションをオプションのオブジェクトとして受け付けます。

監視を止める場合は、ハンドラ関数の返り値を関数として呼び出します。

subscribe(handler: Function)

ストアへのミューテーションを購読します。handler は、全てのミューテーションの後に呼ばれ、引数として、ミューテーションディスクリプタとミューテーション後の状態を受け取ります。

  store.subscribe((mutation, state) => {
    console.log(mutation.type)
    console.log(mutation.payload)
  })

プラグインの中でもっともよく利用されます。詳細

registerModule(path: string | Array<string>, module: Module)

動的なモジュールを登録します。詳細

unregisterModule(path: string | Array<string>)

動的なモジュールを解除します。詳細

hotUpdate(newOptions: Object)

新しいアクションとミューテーションをホットスワップします。詳細

コンポーネントをバインドするヘルパー

mapState(map: Array<string> | Object): Object

ストアのサブツリーを返すコンポーネントの computed オプションを作成します。詳細

mapGetters(map: Array<string> | Object): Object

ゲッターの評価後の値を返すコンポーネントの computed オプションを作成します。詳細

mapActions(map: Array<string> | Object): Object

アクションをディスパッチするコンポーネントの methods オプションを作成します。詳細

mapMutations(map: Array<string> | Object): Object

ミューテーションをコミットするコンポーネントの methods オプションを作成します。詳細

api.md 6.6 KB Permalink History Raw