events-node: clarify purpose of subscriber ID

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2024-11-21 16:33:22 +01:00
parent 44ee7dc170
commit 79a06f6dd9
2 changed files with 6 additions and 1 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-events-node': patch
---
Clarified purpose of subscriber ID in TSDoc for `EventsServiceSubscribeOptions`.
+1 -1
View File
@@ -44,7 +44,7 @@ export interface EventsService {
*/
export type EventsServiceSubscribeOptions = {
/**
* Identifier for the subscription. E.g., used as part of log messages.
* Subscriber ID that is scoped to the calling plugin. Subscribers with the same ID will have events distributed between them.
*/
id: string;
topics: string[];