From b1f0a45e73c5c78176d721160f1cdae520f0d19a Mon Sep 17 00:00:00 2001 From: Julien Le Coupanec Date: Fri, 14 Nov 2025 15:13:01 +0100 Subject: [PATCH] docs(readme): update events documentation --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b1e3c81..db9a183 100644 --- a/README.md +++ b/README.md @@ -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}`) }) ```