Browse Source

Update ja docs (#986)

* add core concepts docs

NOTE:
  pick up from https://github.com/vuejs/vuex/commit/5257afeb246e7ede4b15e1e86778739c0c4ea7bb

* add missing typings docs

NOTE:
  pick up from https://github.com/vuejs/vuex/commit/7ad573bba59d23dbd66e3a25e6614296aeb98d42

* translation missing typings

* update state docs

NOTE:
  pick up from https://github.com/vuejs/vuex/commit/80b856a191fa69f1a620e458c2bc22e7e3d45a06

* update core concepts docs

* tweak translation for ja

* fix nuance

* docs(ja): sync from en docs

* translate previous commit

* docs(ja): fix docs testing

* docs: fix translation
kazuya kawaguchi 7 years ago
parent
commit
bb76bfd31b
5 changed files with 27 additions and 10 deletions
  1. 1 4
      docs/ja/SUMMARY.md
  2. 21 4
      docs/ja/api.md
  3. 2 0
      docs/ja/modules.md
  4. 2 1
      docs/ja/plugins.md
  5. 1 1
      docs/ja/testing.md

+ 1 - 4
docs/ja/SUMMARY.md

@@ -1,10 +1,7 @@
 # Vuex
 
-<!--email_off-->
-> 注意: これは vuex@2.x のドキュメントです
-<!--/email_off-->
+> 注意: TypeScript ユーザ向けは、vuex@>= 3.0 と vue@>=2.5 が必須、逆もまた同様です。
 
-- [1.0のドキュメントをお探しですか?](https://github.com/vuejs/vuex/tree/1.0/docs/ja)
 - [リリースノート](https://github.com/vuejs/vuex/releases)
 - [インストール](installation.md)
 - [Vuex とは何か?](intro.md)

+ 21 - 4
docs/ja/api.md

@@ -12,11 +12,11 @@ const store = new Vuex.Store({ ...options })
 
 - **state**
 
-  - 型: `Object`
+  - 型: `Object | Function`
 
-    ストアのための ルートステートオブジェクトです。
+    ストアのための ルートステートオブジェクトです。[詳細](state.md)
 
-    [詳細](state.md)
+    オブジェクトを返す関数を渡す場合、返されたオブジェクトはルートステートとして使用されます。これは特にモジュールの再利用のためにステートオブジェクトを再利用する場合に便利です。[詳細](modules.md#モジュールの再利用)
 
 - **mutations**
 
@@ -156,10 +156,27 @@ const store = new Vuex.Store({ ...options })
 
   プラグインの中でもっともよく利用されます。[詳細](plugins.md)
 
-- **`registerModule(path: string | Array<string>, module: Module)`**
+- **`subscribeAction(handler: Function)`**
+
+  > 2.5.0 で新規追加
+
+  ストアアクションを購読します。`handler` はディスパッチされたアクションごとに呼び出され、アクション記述子と現在のストア状態を引数として受け取ります:
+
+  ``` js
+  store.subscribeAction((action, state) => {
+    console.log(action.type)
+    console.log(action.payload)
+  })
+  ```
+
+ プラグインで最も一般的に使用されます。[Details](plugins.md)
+
+- **`registerModule(path: string | Array<string>, module: Module, options?: Object)`**
 
   動的なモジュールを登録します。[詳細](modules.md#dynamic-module-registration)
 
+  `options` は前の状態を保存する `preserveState: true` を持つことができます。サーバサイドレンダリングに役立ちます。
+
 - **`unregisterModule(path: string | Array<string>)`**
 
   動的なモジュールを解除します。[詳細](modules.md#dynamic-module-registration)

+ 2 - 0
docs/ja/modules.md

@@ -269,6 +269,8 @@ store.registerModule(['nested', 'myModule'], {
 
 `store.unregisterModule(moduleName)` を呼び出せば、動的に登録したモジュールを削除できます。ただしストア作成(store creation)の際に宣言された、静的なモジュールはこのメソッドで削除できないことに注意してください。
 
+サーバサイドレンダリングされたアプリケーションから状態を保持するなど、新しいモジュールを登録するときに、以前の状態を保持したい場合があります。`preserveState` オプション(`store.registerModule('a', module, { preserveState: true })`)でこれを実現できます。
+
 ### モジュールの再利用
 
 時どき、モジュールの複数インスタンスを作成する必要があるかもしれません。例えば:

+ 2 - 1
docs/ja/plugins.md

@@ -116,7 +116,8 @@ const logger = createLogger({
     // ミューテーションは、`{ type, payload }` の形式でログ出力されます
     // 任意の方法でそれをフォーマットできます
     return mutation.type
-  }
+  },
+  logger: console, // `console` API の実装, デフォルトは `console`
 })
 ```
 

+ 1 - 1
docs/ja/testing.md

@@ -218,4 +218,4 @@ mocha test-bundle.js
 
 #### Karma + karma-webpack を使ったブラウザでの実行
 
-[vue-loader documentation](http://vue-loader.vuejs.org/en/workflow/testing.html) 内のセットアップ方法を参考にしてください。
+[vue-loader ドキュメント](https://vue-loader.vuejs.org/ja/workflow/testing.html) 内のセットアップ方法を参考にしてください。