Add @public with description of it's functionality

Signed-off-by: Jenah Blitz <jenah.blitz@simplybusiness.com>
2023-01-26 15:59:20 -05:00
parent 41377156d0
commit c5965be60c
1 changed files with 4 additions and 0 deletions
@@ -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]);