From 79a06f6dd9ab3eca92bc4a62ad176270b4e2c384 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Thu, 21 Nov 2024 16:33:22 +0100 Subject: [PATCH] events-node: clarify purpose of subscriber ID Signed-off-by: Patrik Oldsberg --- .changeset/khaki-ladybugs-swim.md | 5 +++++ plugins/events-node/src/api/EventsService.ts | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 .changeset/khaki-ladybugs-swim.md diff --git a/.changeset/khaki-ladybugs-swim.md b/.changeset/khaki-ladybugs-swim.md new file mode 100644 index 0000000000..79cc1358df --- /dev/null +++ b/.changeset/khaki-ladybugs-swim.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-events-node': patch +--- + +Clarified purpose of subscriber ID in TSDoc for `EventsServiceSubscribeOptions`. diff --git a/plugins/events-node/src/api/EventsService.ts b/plugins/events-node/src/api/EventsService.ts index 3426f646e7..6547ea9889 100644 --- a/plugins/events-node/src/api/EventsService.ts +++ b/plugins/events-node/src/api/EventsService.ts @@ -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[];