From 2e8d09d3fe7145380024b5370c13f43d9fce1d97 Mon Sep 17 00:00:00 2001 From: Kazuhiro Sera Date: Thu, 26 Mar 2020 18:48:11 +0900 Subject: [PATCH] Apply the changes corresponding to the suggestions https://github.com/slackapi/bolt/pull/442 --- docs/_advanced/ja_error_handling.md | 4 ++-- docs/_advanced/ja_middleware_global.md | 2 +- docs/_advanced/ja_middleware_listener.md | 2 +- docs/_basic/ja_listening_actions.md | 2 +- docs/_tutorials/ja_migration_v2.md | 6 +++--- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/_advanced/ja_error_handling.md b/docs/_advanced/ja_error_handling.md index 8c05a5548..d44afe157 100644 --- a/docs/_advanced/ja_error_handling.md +++ b/docs/_advanced/ja_error_handling.md @@ -6,9 +6,9 @@ order: 1 ---
-*注: Bolt 2.x からエラーハンドリングが改善されました！詳細は [2.x マイグレーションガイド](https://slack.dev/bolt/ja-jp/tutorial/migration-v2)を参照してください。* +*注: Bolt 2.x からエラーハンドリングが改善されました！この変更については [2.x マイグレーションガイド](https://slack.dev/bolt/ja-jp/tutorial/migration-v2)を参照してください。* -リスナーでエラーが発生した場合は `try`/`catch` を使って直接ハンドリングすることをおすすめします。しかし、それでもなおすり抜けてしまうエラーのパターンもあるでしょう。デフォルトでは、このようなエラーはコンソールにログ出力されます。ご自身でこれらをハンドリングするには、`error(fn)` メソッドによって、グローバルエラーハンドラーを定義してください。 +リスナーでエラーが発生した場合は `try`/`catch` を使って直接ハンドリングすることをおすすめします。しかし、それでもなおすり抜けてしまうエラーのパターンもあるでしょう。デフォルトでは、このようなエラーはコンソールにログ出力されます。ご自身でこれらをハンドリングするには、`app.error(fn)` メソッドによって、グローバルエラーハンドラーを定義してください。
```javascript diff --git a/docs/_advanced/ja_middleware_global.md b/docs/_advanced/ja_middleware_global.md index 7dc595f44..cb1abda39 100644 --- a/docs/_advanced/ja_middleware_global.md +++ b/docs/_advanced/ja_middleware_global.md @@ -12,7 +12,7 @@ order: 4 たとえば、アプリが、対応する内部認証サービス (SSO プロバイダ、LDAP など) で識別されたユーザーにのみ応答する必要があるとします。この場合、グローバルミドルウェアを使用して認証サービス内のユーザーレコードを検索し、ユーザーが見つからない場合はエラーとなるように定義するのがよいでしょう。 -*注: Bolt 2.x からグローバルミドルウェアが `async` 関数をサポートしました！詳細は [2.x マイグレーションガイド](https://slack.dev/bolt/ja-jp/tutorial/migration-v2)を参照してください。* +*注: Bolt 2.x からグローバルミドルウェアが `async` 関数をサポートしました！この変更については [2.x マイグレーションガイド](https://slack.dev/bolt/ja-jp/tutorial/migration-v2)を参照してください。* ```javascript diff --git a/docs/_advanced/ja_middleware_listener.md b/docs/_advanced/ja_middleware_listener.md index 19cd13f2c..d9e016bbd 100644 --- a/docs/_advanced/ja_middleware_listener.md +++ b/docs/_advanced/ja_middleware_listener.md @@ -14,7 +14,7 @@ order: 5 たとえば、リスナーが人間からのメッセージのみを扱うのであれば、ボットメッセージを除外するリスナーミドルウェアを作成できます。 -*注: Bolt 2.x からミドルウェアが `async` 関数をサポートしました！詳細は [2.x マイグレーションガイド](https://slack.dev/bolt/ja-jp/tutorial/migration-v2)を参照してください。* +*注: Bolt 2.x からミドルウェアが `async` 関数をサポートしました！この変更については [2.x マイグレーションガイド](https://slack.dev/bolt/ja-jp/tutorial/migration-v2)を参照してください。* ```javascript diff --git a/docs/_basic/ja_listening_actions.md b/docs/_basic/ja_listening_actions.md index 44de67bd1..e272615d8 100644 --- a/docs/_basic/ja_listening_actions.md +++ b/docs/_basic/ja_listening_actions.md @@ -12,7 +12,7 @@ order: 5 すべての `action()` の例で `ack()` が使用されていることに注目してください。Slack からイベントを受信したことを確認するために、アクションリスナー内で `ack()` 関数を呼び出す必要があります。これについては、「[イベントの確認](#acknowledge)」 セクションで説明しています。 -*注: Bolt 2.x からメッセージショートカット（以前はメッセージアクションと呼ばれていました）は `action()` ではなく `shortcut()` メソッドを使用するようになりました。詳細は [2.x マイグレーションガイド](https://slack.dev/bolt/ja-jp/tutorial/migration-v2)を参照してください。* +*注: Bolt 2.x からメッセージショートカット（以前はメッセージアクションと呼ばれていました）は `action()` ではなく `shortcut()` メソッドを使用するようになりました。この変更については [2.x マイグレーションガイド](https://slack.dev/bolt/ja-jp/tutorial/migration-v2)を参照してください。* ```javascript diff --git a/docs/_tutorials/ja_migration_v2.md b/docs/_tutorials/ja_migration_v2.md index 5fca4dd56..1fa8a3a4b 100644 --- a/docs/_tutorials/ja_migration_v2.md +++ b/docs/_tutorials/ja_migration_v2.md @@ -9,7 +9,7 @@ permalink: /ja-jp/tutorial/migration-v2 # 2.x マイグレーションガイド
-このガイドは Bolt 1.x を利用しているアプリを 2.x にアップグレードするための手順について説明します。 +このガイドは Bolt 1.x を利用しているアプリを 2.x にアップグレードするための手順について説明します。いくつかの変更が必要とはなりますが、ほとんどのアプリの場合で、おそらく対応に必要な時間は 5 〜 15 分程度です。
--- @@ -67,7 +67,7 @@ app.error((error) => { その他のエラーに関する変更: - リスナー関数が `ack()` メソッドを 3 秒間のうちに呼び出さなかった場合、これまでのように例外を投げるのではなくログを出力するようになりました -- もしミドルウェア実行中に複数のエラーが発生した場合、Bolt for JavaScript は `slack_bolt_multiple_listener_error` という `code` と全てのエラーで構成される配列を含む `original` というパラメーターをラップしたエラーを返します +- もし一つのイベントに対して複数のリスナー関数を実行中に複数のエラーが発生した場合、Bolt for JavaScript は `ErrorCode.MultipleListenerError` の値での `code` と、発生した個々のエラーの配列を含む `originals` というパラメーターをラップしたエラーを返します ## メッセージショートカット @@ -76,7 +76,7 @@ app.error((error) => { これまで: ```javascript -app.action('message-action-callback', ({action, ack, context}) => { +app.action({ callback_id: 'message-action-callback' }, ({action, ack, context}) => { ack(); // ここで処理を行う })