Skip to content

Commit

Permalink
Document events in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
singpolyma committed Jan 8, 2025
1 parent 6ff7e81 commit d689816
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion packages/stream-management/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,13 @@ When the session is resumed the `online` event is not emitted as session resumpt
However `entity.status` is set to `online`.
If the session fails to resume, entity will fallback to regular session establishment in which case `online` event will be emitted.

Automatically responds to acks but does not support requesting acks yet.
Automatically responds to acks and requests them. Also requests periodically even if you haven't sent anything. If server fails to respond to a request, the module triggers a reconnect.

## Events

**resumed**: Indicates that the connection was resumed (so online with no online event)
**fail**: Indicates that a stanza failed to send to the server and will not be retried
**ack**: Indicates that a stanza has been acknowledged by the server

## References

Expand Down

0 comments on commit d689816

Please sign in to comment.