Merge pull request #350 from ekmartin/action_event_doc

Add information about action events in the docs
martynsmith · Apr 15, 2015 · 1d5127d · 1d5127d
2 parents 31bc7d8 + 251d166
commit 1d5127d
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/API.rst b/docs/API.rst
@@ -462,6 +462,13 @@ Events
     Emitted when ever the server responds with an error-type message. The message
     parameter is exactly as in the 'raw' event.
 
+.. js:data:: 'action'
+
+    `function (from, to, text, message) { }`
+
+    Emitted whenever a user performs an action (e.g. `/me waves`).
+    The message parameter is exactly as in the 'raw' event.
+
 Colors
 ------