diff --git a/docs/ja/api/README.md b/docs/ja/api/README.md index 5adaf6a..f420a72 100644 --- a/docs/ja/api/README.md +++ b/docs/ja/api/README.md @@ -147,27 +147,27 @@ const store = new Vuex.Store({ ...options }) ### commit -- **`commit(type: string, payload?: any, options?: Object)`** -- **`commit(mutation: Object, options?: Object)`** +- `commit(type: string, payload?: any, options?: Object)` +- `commit(mutation: Object, options?: Object)` ミューテーションをコミットします。`options` は[名前空間付きモジュール](../guide/modules.md#名前空間)で root なミューテーションにコミットできる `root: true` を持つことできます。[詳細](../guide/mutations.md) ### dispatch -- **`dispatch(type: string, payload?: any, options?: Object): Promise`** -- **`dispatch(action: Object, options?: Object): Promise`** +- `dispatch(type: string, payload?: any, options?: Object): Promise` +- `dispatch(action: Object, options?: Object): Promise` アクションをディスパッチします。`options` は[名前空間付きモジュール](../guide/modules.md#名前空間)で root なアクションにディスパッチできる `root: true` を持つことできます。 すべてのトリガーされたアクションハンドラを解決するPromiseを返します。[詳細](../guide/actions.md) ### replaceState -- **`replaceState(state: Object)`** +- `replaceState(state: Object)` ストアのルートステートを置き換えます。これは、ステートのハイドレーションやタイムトラベルのためだけに利用すべきです。 ### watch -- **`watch(fn: Function, callback: Function, options?: Object): Function`** +- `watch(fn: Function, callback: Function, options?: Object): Function` `fn`が返す値をリアクティブに監視し、値が変わった時にコールバックを呼びます。`fn`は最初の引数としてストアのステートを、2番目の引数としてゲッターを受け取ります。 [Vue の`vm.$watch`メソッド](https://jp.vuejs.org/v2/api/#watch)と同じオプションをオプションのオブジェクトとして受け付けます。 @@ -175,7 +175,7 @@ const store = new Vuex.Store({ ...options }) ### subscribe -- **`subscribe(handler: Function): Function`** +- `subscribe(handler: Function): Function` ストアへのミューテーションを購読します。`handler` は、全てのミューテーションの後に呼ばれ、引数として、ミューテーション ディスクリプタとミューテーション後の状態を受け取ります。 @@ -192,7 +192,7 @@ const store = new Vuex.Store({ ...options }) ### subscribeAction -- **`subscribeAction(handler: Function)`** +- `subscribeAction(handler: Function)` > 2.5.0 で新規追加 @@ -226,7 +226,7 @@ const store = new Vuex.Store({ ...options }) ### registerModule -- **`registerModule(path: string | Array, module: Module, options?: Object)`** +- `registerModule(path: string | Array, module: Module, options?: Object)` 動的なモジュールを登録します。[詳細](../guide/modules.md#dynamic-module-registration) @@ -234,7 +234,7 @@ const store = new Vuex.Store({ ...options }) ### unregisterModule -- **`unregisterModule(path: string | Array)`** +- `unregisterModule(path: string | Array)` 動的なモジュールを解除します。[詳細](../guide/modules.md#dynamic-module-registration) @@ -246,7 +246,7 @@ const store = new Vuex.Store({ ...options }) ### hotUpdate -- **`hotUpdate(newOptions: Object)`** +- `hotUpdate(newOptions: Object)` 新しいアクションとミューテーションをホットスワップします。[詳細](../guide/hot-reload.md) @@ -254,7 +254,7 @@ const store = new Vuex.Store({ ...options }) ### mapState -- **`mapState(namespace?: string, map: Array | Object): Object`** +- `mapState(namespace?: string, map: Array | Object): Object` ストアのサブツリーを返すコンポーネントの computed オプションを作成します。[詳細](../guide/state.md#the-mapstate-helper) @@ -264,7 +264,7 @@ const store = new Vuex.Store({ ...options }) ### mapGetters -- **`mapGetters(namespace?: string, map: Array | Object): Object`** +- `mapGetters(namespace?: string, map: Array | Object): Object` ゲッターの評価後の値を返すコンポーネントの computed オプションを作成します。[詳細](../guide/getters.md#the-mapgetters-helper) @@ -272,7 +272,7 @@ const store = new Vuex.Store({ ...options }) ### mapActions -- **`mapActions(namespace?: string, map: Array | Object): Object`** +- `mapActions(namespace?: string, map: Array | Object): Object` アクションをディスパッチするコンポーネントの methods オプションを作成します。[詳細](../guide/actions.md#dispatching-actions-in-components) @@ -282,7 +282,7 @@ const store = new Vuex.Store({ ...options }) ### mapMutations -- **`mapMutations(namespace?: string, map: Array | Object): Object`** +- `mapMutations(namespace?: string, map: Array | Object): Object` ミューテーションをコミットするコンポーネントの methods オプションを作成します。[詳細](../guide/mutations.md#commiting-mutations-in-components) @@ -292,6 +292,6 @@ const store = new Vuex.Store({ ...options }) ### createNamespaceHelpers -- **`createNamespacedHelpers(namespace: string): Object`** +- `createNamespacedHelpers(namespace: string): Object` 名前空間付けられたコンポーネントバインディングのヘルパーを作成します。返されるオブジェクトは指定された名前空間にバインドされた `mapState`、`mapGetters`、`mapActions` そして `mapMutations` が含まれます。[詳細はこちら](../guide/modules.md#binding-helpers-with-namespace)