Skip to content

Commit

Permalink
docs(ja): align style of api method description to other locales
Browse files Browse the repository at this point in the history
  • Loading branch information
kiaking committed Apr 23, 2020
1 parent 19e6337 commit f698a26
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions docs/ja/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,35 +147,35 @@ 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<any>`**
- **`dispatch(action: Object, options?: Object): Promise<any>`**
- `dispatch(type: string, payload?: any, options?: Object): Promise<any>`
- `dispatch(action: Object, options?: Object): Promise<any>`

アクションをディスパッチします。`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)と同じオプションをオプションのオブジェクトとして受け付けます。

監視を止める場合は、返された unwatch 関数を呼び出します。

### subscribe

- **`subscribe(handler: Function): Function`**
- `subscribe(handler: Function): Function`

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

Expand All @@ -192,7 +192,7 @@ const store = new Vuex.Store({ ...options })

### subscribeAction

- **`subscribeAction(handler: Function)`**
- `subscribeAction(handler: Function)`

> 2.5.0 で新規追加

Expand Down Expand Up @@ -226,15 +226,15 @@ const store = new Vuex.Store({ ...options })

### registerModule

- **`registerModule(path: string | Array<string>, module: Module, options?: Object)`**
- `registerModule(path: string | Array<string>, module: Module, options?: Object)`

動的なモジュールを登録します。[詳細](../guide/modules.md#dynamic-module-registration)

`options` は前の状態を保存する `preserveState: true` を持つことができます。サーバサイドレンダリングに役立ちます。

### unregisterModule

- **`unregisterModule(path: string | Array<string>)`**
- `unregisterModule(path: string | Array<string>)`

動的なモジュールを解除します。[詳細](../guide/modules.md#dynamic-module-registration)

Expand All @@ -246,15 +246,15 @@ const store = new Vuex.Store({ ...options })

### hotUpdate

- **`hotUpdate(newOptions: Object)`**
- `hotUpdate(newOptions: Object)`

新しいアクションとミューテーションをホットスワップします。[詳細](../guide/hot-reload.md)

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

### mapState

- **`mapState(namespace?: string, map: Array<string> | Object<string | function>): Object`**
- `mapState(namespace?: string, map: Array<string> | Object<string | function>): Object`

ストアのサブツリーを返すコンポーネントの computed オプションを作成します。[詳細](../guide/state.md#the-mapstate-helper)

Expand All @@ -264,15 +264,15 @@ const store = new Vuex.Store({ ...options })

### mapGetters

- **`mapGetters(namespace?: string, map: Array<string> | Object<string>): Object`**
- `mapGetters(namespace?: string, map: Array<string> | Object<string>): Object`

ゲッターの評価後の値を返すコンポーネントの computed オプションを作成します。[詳細](../guide/getters.md#the-mapgetters-helper)

1引数は、オプションで名前空間文字列にすることができます。[詳細](../guide/modules.md#binding-helpers-with-namespace)

### mapActions

- **`mapActions(namespace?: string, map: Array<string> | Object<string | function>): Object`**
- `mapActions(namespace?: string, map: Array<string> | Object<string | function>): Object`

アクションをディスパッチするコンポーネントの methods オプションを作成します。[詳細](../guide/actions.md#dispatching-actions-in-components)

Expand All @@ -282,7 +282,7 @@ const store = new Vuex.Store({ ...options })

### mapMutations

- **`mapMutations(namespace?: string, map: Array<string> | Object<string | function>): Object`**
- `mapMutations(namespace?: string, map: Array<string> | Object<string | function>): Object`

ミューテーションをコミットするコンポーネントの methods オプションを作成します。[詳細](../guide/mutations.md#commiting-mutations-in-components)

Expand All @@ -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)

0 comments on commit f698a26

Please sign in to comment.