Skip to content

Commit 08bd0d9

Browse files
kazuponktsn
authored andcommitted
docs(ja): update ja docs (#1400)
* docs(ja): pick up ref: f5ff95e * docs(ja): translate previous commit * docs(ja): pick up ref: af46a3c * docs(ja): translate previous commit * docs(ja): translate api docs ref: 432487b * docs(ja): pick up ref: d16c906 * docs(ja): translate previous commit * docs(ja): some tweaks ref: 677e69a ref: d1c834a * docs(ja): pick up ref: 4a0d959 * docs(ja): translate previous commit * docs(ja): pick up ref: 5dec460 * docs(ja): fix review comments * docs(ja): プロミス -> Promise
1 parent b205e9f commit 08bd0d9

File tree

5 files changed

+85
-9
lines changed

5 files changed

+85
-9
lines changed

docs/ja/api/README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -154,15 +154,15 @@ const store = new Vuex.Store({ ...options })
154154

155155
### watch
156156

157-
- **`watch(getter: Function, cb: Function, options?: Object)`**
157+
- **`watch(fn: Function, callback: Function, options?: Object): Function`**
158158

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

161-
監視を止める場合は、ハンドラ関数の返り値を関数として呼び出します
161+
監視を止める場合は、返された unwatch 関数を呼び出します
162162

163163
### subscribe
164164

165-
- **`subscribe(handler: Function)`**
165+
- **`subscribe(handler: Function): Function`**
166166

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

@@ -173,6 +173,8 @@ const store = new Vuex.Store({ ...options })
173173
})
174174
```
175175

176+
購読を停止するには、返された unsubscribe 関数呼び出します。
177+
176178
プラグインの中でもっともよく利用されます。[詳細](../guide/plugins.md)
177179

178180
### subscribeAction
@@ -216,36 +218,42 @@ const store = new Vuex.Store({ ...options })
216218

217219
### mapState
218220

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

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

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

227+
2引数のオブジェクトのメンバーには関数 `function(state: any)` を指定できます。
228+
225229
### mapGetters
226230

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

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

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

233237
### mapActions
234238

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

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

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

245+
2引数のオブジェクトのメンバーには関数 `function(dispatch: function, ...args: any[])` を指定できます。
246+
241247
### mapMutations
242248

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

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

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

255+
2引数のオブジェクトのメンバーには関数 `function(commit: function, ...args: any[])` を指定できます。
256+
249257
### createNamespaceHelpers
250258

251259
- **`createNamespacedHelpers(namespace: string): Object`**

docs/ja/guide/getters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ export default {
109109

110110
``` js
111111
...mapGetters({
112-
// `this.doneCount` を `store.getters.doneTodosCount` にマッピングさせる
112+
// `this.doneCount` を `this.$store.getters.doneTodosCount` にマッピングさせる
113113
doneCount: 'doneTodosCount'
114114
})
115115
```

docs/ja/guide/modules.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,32 @@ modules: {
170170
}
171171
```
172172

173+
#### 名前空間付きモジュールでのグローバルアクションへの登録
174+
175+
名前空間付きモジュールでグローバルアクションに登録したい場合、`root: true` でそれをマークでき、そしてアクション定義を `handler` 関数に置くことができます。例えば:
176+
177+
``` js
178+
{
179+
actions: {
180+
someOtherAction ({dispatch}) {
181+
dispatch('someAction')
182+
}
183+
},
184+
modules: {
185+
foo: {
186+
namespaced: true,
187+
actions: {
188+
someAction: {
189+
root: true,
190+
handler (namespacedContext, payload) { ... } // -> 'someAction'
191+
}
192+
}
193+
}
194+
}
195+
}
196+
```
197+
198+
173199
#### 名前空間によるバインディングヘルパー
174200

175201
`mapState``mapGetters``mapActions`、そして `mapMutations` ヘルパーを使って名前空間付きモジュールをコンポーネントにバインディングするとき、少し冗長になります:

docs/ja/guide/testing.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,23 @@ describe('actions', () => {
127127
})
128128
```
129129

130+
テスト環境において利用可能なスパイがあるのなら(例えば[Sinon.JS](http://sinonjs.org/))、`testAction` ヘルパーの代わりにそれらを使用できます:
131+
``` js
132+
describe('actions', () => {
133+
it('getAllProducts', () => {
134+
const commit = sinon.spy()
135+
const state = {}
136+
137+
actions.getAllProducts({ commit, state })
138+
139+
expect(commit.args).to.deep.equal([
140+
['REQUEST_PRODUCTS'],
141+
['RECEIVE_PRODUCTS', { /* レスポンスのモック */ }]
142+
])
143+
})
144+
})
145+
```
146+
130147
### ゲッターのテスト
131148

132149
もしゲッターが複雑な計算を行っているならば、テストコードを書く価値があります。ゲッターはミューテーションと同様の理由でテストしやすいです。

docs/ja/installation.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,31 @@ Vue.use(Vuex)
3838

3939
グローバルなスクリプトタグを利用する場合にはこのようにする必要はありません。
4040

41+
### Promise
42+
43+
Vuex は [Promise (プロミス)](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises) を必要とします。ブラウザで Promise が実装されていない(例 IE)場合は、[es6-promise](https://github.com/stefanpenner/es6-promise) のようなポリフィルライブラリを使用できます。
44+
45+
CDN 経由でそれを含めることができます:
46+
47+
``` html
48+
<script src="https://cdn.jsdelivr.net/npm/es6-promise@4/dist/es6-promise.auto.js"></script>
49+
```
50+
51+
`window.Promise` は自動的に有効になります。
52+
53+
NPM または Yarn のようなパッケージマネージャーを使用するのを希望する場合は、以下のコマンドでインストールします:
54+
55+
``` bash
56+
npm install es6-promise --save # NPM
57+
yarn add es6-promise # Yarn
58+
```
59+
60+
さらに、Vuex を使用する前に、コードのどこかに次の行を追加します:
61+
62+
``` js
63+
import 'es6-promise/auto'
64+
```
65+
4166
### 開発版ビルド
4267

4368
最新の開発版ビルドを利用したい場合には、 Github から直接クローンし `vuex` を自身でビルドする必要があります。

0 commit comments

Comments
 (0)