Merge pull request #23986 from marleypowell/patch-1

Update README.md for signals plugin
This commit is contained in:
Ben Lambert
2024-04-09 11:24:30 +02:00
committed by GitHub
3 changed files with 10 additions and 4 deletions
+6
View File
@@ -0,0 +1,6 @@
---
'@backstage/plugin-signals-react': patch
'@backstage/plugin-signals': patch
---
fixed typo in docs
+2 -2
View File
@@ -38,9 +38,9 @@ You can also use the signal API directly. This allows more fine-grained control
subscriptions.
```ts
import { signalsApiRef } from '@backstage/plugin-signals-react';
import { signalApiRef } from '@backstage/plugin-signals-react';
const signals = useApi(signalsApiRef);
const signals = useApi(signalApiRef);
const { unsubscribe } = signals.subscribe(
'myplugin:channel',
(message: JsonObject) => {
+2 -2
View File
@@ -30,9 +30,9 @@ const app = createApp({
Now you can utilize the API from other plugins using the `@backstage/plugin-signals-react` package or simply by:
```ts
import { signalsApiRef } from '@backstage/plugin-signals-react';
import { signalApiRef } from '@backstage/plugin-signals-react';
const signals = useApi(signalsApiRef);
const signals = useApi(signalApiRef);
const { unsubscribe } = signals.subscribe(
'myplugin:topic',
(message: JsonObject) => {