From 71e844886fa48f4c0a585d7d88538f6d38872a13 Mon Sep 17 00:00:00 2001 From: Juho Heikka Date: Thu, 7 Oct 2021 14:36:46 +0300 Subject: [PATCH] Fix comment addOnBeforeRun to match changed API Signed-off-by: Juho Heikka --- src/extensions/renderer-api/catalog.ts | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/extensions/renderer-api/catalog.ts b/src/extensions/renderer-api/catalog.ts index 8486eb10d7..feccc79353 100644 --- a/src/extensions/renderer-api/catalog.ts +++ b/src/extensions/renderer-api/catalog.ts @@ -51,9 +51,11 @@ export class CatalogEntityRegistry { } /** - * Add a onBeforeRun hook to a catalog entity. If `onBeforeRun` was previously added then it will not be added again - * @param catalogEntityUid The uid of the catalog entity - * @param onBeforeRun The function that should return a boolean if the onRun of catalog entity should be triggered. + * Add a onBeforeRun hook to a catalog entities. If `onBeforeRun` was previously + * added then it will not be added again. + * @param onBeforeRun The function will receive the catalog entity as a parameter. + * Hook function should return a boolean that determines if the running sequence + * should continue to onRun. * @returns A function to remove that hook */ addOnBeforeRun(onBeforeRun: CatalogEntityOnBeforeRun): Disposer {