Permalink
Browse files

Add some pointers to middleware, Express, and Socket.io events.

  • Loading branch information...
1 parent a28fab2 commit 2699389a3f7d6fbd01e89e32d2846369e9a383cb @shimaore shimaore committed Apr 3, 2013
Showing with 12 additions and 0 deletions.
  1. +12 −0 docs/reference.md
View
@@ -5,6 +5,14 @@ title: API Reference (v0.4.21)
# {{page.title}}
+## References
+
+For a list of standard middleware, see [the Connect documentation](http://www.senchalabs.org/connect/).
+
+A lot of Zappa methods are shortcuts or extensions of the [Express API](http://expressjs.com/api.html).
+
+Only some of the [Socket.IO events](https://github.com/LearnBoost/socket.io/wiki/Exposed-events) are documented here.
+
## EXPORTS
`require 'zappajs'` returns a function with the following attributes:
@@ -147,6 +155,8 @@ Shortcut to socket.io's `socket.on 'event'`.
The handler functions will have access to all variables described in the **sockets handlers scope** section. They won't have access to their parent scope. To make variables available to these handlers, use `helper`.
+Some standard [events](https://github.com/LearnBoost/socket.io/wiki/Exposed-events): `connection`, `message`, `disconnect`.
+
### @helper
Helpers content is made available to both the request handler and sockets handler scopes.
@@ -780,6 +790,8 @@ Should be called first when the client is started to establish the Socket.IO web
Event handlers with socket.io.
+Some standard [events](https://github.com/LearnBoost/socket.io/wiki/Exposed-events#client): `connect`, `connecting`, `disconnect`, `connect_failed`, `error`, `message`, `reconnect_failed`, `reconnect`, `reconnecting`.
+
### @emit
Send a message to the server.

0 comments on commit 2699389

Please sign in to comment.