docs: add note for authResult in channels

fratzinger · Mar 29, 2023 · b337e90 · b337e90
1 parent 98e24cc
commit b337e90
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/docs/channels.md b/docs/channels.md
@@ -14,6 +14,24 @@ export default function (app) {
     return;
   }
 
+  // ...
+
+  app.on("login", (authResult: any, { connection }) => {
+    if (connection) {
+      // this is needed to map the ability from the authentication hook to the connection so it gets available in the HookContext as `params.ability` automatically
+      if (authResult.ability) {
+        connection.ability = authResult.ability;
+        connection.rules = authResult.rules;
+      }
+
+      // ...
+    }
+
+    // ...
+  });
+
+  // ...
+
   const caslOptions = makeChannelOptions(app);
 
   app.publish((data, context) => {

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -260,6 +260,21 @@ export default function (app) {
     // If no real-time functionality has been configured just return
     return;
   }
+  // ...
+
+  app.on("login", (authResult: any, { connection }) => {
+    if (connection) {
+      // this is needed to map the ability from the authentication hook to the connection so it gets available in the HookContext as `params.ability` automatically
+      if (authResult.ability) {
+        connection.ability = authResult.ability;
+        connection.rules = authResult.rules;
+      }
+
+      // ...
+    }
+  });
+
+  // ...
 
   const caslOptions = makeChannelOptions(app);