hendrik/lens
1
0
Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

Fix comment addOnBeforeRun to match changed API

Browse Source 
Signed-off-by: Juho Heikka <juho.heikka@gmail.com>
This commit is contained in:
Juho Heikka 2021-10-07 14:36:46 +03:00
parent f7ea0b51db
commit 71e844886f
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/extensions/renderer-api/catalog.ts
View File

@ -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 * Add a onBeforeRun hook to a catalog entities. If `onBeforeRun` was previously
* @param catalogEntityUid The uid of the catalog entity * added then it will not be added again.
* @param onBeforeRun The function that should return a boolean if the onRun of catalog entity should be triggered. * @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 * @returns A function to remove that hook
*/ */
addOnBeforeRun(onBeforeRun: CatalogEntityOnBeforeRun): Disposer { addOnBeforeRun(onBeforeRun: CatalogEntityOnBeforeRun): Disposer {