events-node: clarify purpose of subscriber ID
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@backstage/plugin-events-node': patch
|
||||
---
|
||||
|
||||
Clarified purpose of subscriber ID in TSDoc for `EventsServiceSubscribeOptions`.
|
||||
@@ -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[];
|
||||
|
||||
Reference in New Issue
Block a user