From c5965be60c9e33b7f531f95c74bf711d6dd22409 Mon Sep 17 00:00:00 2001 From: Jenah Blitz Date: Thu, 26 Jan 2023 15:59:20 -0500 Subject: [PATCH] Add @public with description of it's functionality Signed-off-by: Jenah Blitz --- plugins/airbrake/src/components/isAirbrakeAvailable.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/plugins/airbrake/src/components/isAirbrakeAvailable.ts b/plugins/airbrake/src/components/isAirbrakeAvailable.ts index 93c04061c2..01d59668ce 100644 --- a/plugins/airbrake/src/components/isAirbrakeAvailable.ts +++ b/plugins/airbrake/src/components/isAirbrakeAvailable.ts @@ -17,5 +17,9 @@ import { Entity } from '@backstage/catalog-model'; import { AIRBRAKE_PROJECT_ID_ANNOTATION } from './useProjectId'; +/** + * Utility function to determine if the given entity has an Airbrake ID set in the repos catalog-info.yml . + * @public + */ export const isAirbrakeAvailable = (entity: Entity) => Boolean(entity.metadata.annotations?.[AIRBRAKE_PROJECT_ID_ANNOTATION]);