From 67ddf8d6d79e2d2e214411f2be8f2b2114039b02 Mon Sep 17 00:00:00 2001 From: Heikki Hellgren Date: Wed, 3 Jan 2024 13:03:53 +0200 Subject: [PATCH] docs: fix example of signal api in README Signed-off-by: Heikki Hellgren --- plugins/signals/README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/plugins/signals/README.md b/plugins/signals/README.md index e70c1ef7d8..7b96da32f1 100644 --- a/plugins/signals/README.md +++ b/plugins/signals/README.md @@ -33,9 +33,12 @@ Now you can utilize the API from other plugins using the `@backstage/plugin-sign import { signalsApiRef } from '@backstage/plugin-signals-react'; const signals = useApi(signalsApiRef); -signals.subscribe('myplugin:topic', (message: JsonObject) => { - console.log(message); -}); +const { unsubscribe } = signals.subscribe( + 'myplugin:topic', + (message: JsonObject) => { + console.log(message); + }, +); // Remember to unsubscribe -signals.unsubscribe('myplugin:topic'); +unsubscribe(); ```