Skip to content

docs(readme): update events documentation #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thetutlage merged 1 commit into from
Nov 16, 2025
Merged

docs(readme): update events documentation #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 18 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,24 +154,32 @@ export default defineConfig({
Transmit uses [Emittery](https://github.com/sindresorhus/emittery) to emit any lifecycle events. You can listen for events using the `on` method.

```ts
transmit.on('connect', ({ uid }) => {
console.log(`Connected: ${uid}`)
transmit.on('broadcast', ({ channel, payload }) => {
logger.debug('TRANSMIT broadcasted')
logger.debug(`─ channel: ${channel}`)
logger.debug(`─ payload: ${JSON.stringify(payload)}`)
})

transmit.on('disconnect', ({ uid }) => {
console.log(`Disconnected: ${uid}`)
transmit.on('connect', ({ uid }) => {
logger.debug('TRANSMIT connected')
logger.debug(`─ uid: ${uid}`)
})

transmit.on('broadcast', ({ channel }) => {
console.log(`Broadcasted to channel ${channel}`)
transmit.on('disconnect', ({ uid }) => {
logger.debug('TRANSMIT disconnected')
logger.debug(`─ uid: ${uid}`)
})

transmit.on('subscribe', ({ uid, channel }) => {
console.log(`Subscribed ${uid} to ${channel}`)
transmit.on('subscribe', ({ channel, uid }) => {
logger.debug('TRANSMIT subscribed')
logger.debug(`─ channel: ${channel}`)
logger.debug(`─ uid: ${uid}`)
})

transmit.on('unsubscribe', ({ uid, channel }) => {
console.log(`Unsubscribed ${uid} from ${channel}`)
transmit.on('unsubscribe', ({ channel, uid }) => {
logger.debug('TRANSMIT unsubscribed')
logger.debug(`─ channel: ${channel}`)
logger.debug(`─ uid: ${uid}`)
})
```

Expand Down