1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00

Update catalog API comment

Co-authored-by: Sebastian Malton <sebastian@malton.name>
Signed-off-by: Juho Heikka <juho.heikka@gmail.com>
This commit is contained in:
Juho Heikka 2021-10-07 18:24:23 +03:00
parent 3e500abf3f
commit 588e08f6c3

View File

@ -53,7 +53,7 @@ export class CatalogEntityRegistry {
/** /**
* Add a onBeforeRun hook to a catalog entities. If `onBeforeRun` was previously * Add a onBeforeRun hook to a catalog entities. If `onBeforeRun` was previously
* added then it will not be added again. * added then it will not be added again.
* @param onBeforeRun The function will receive the catalog run event as a parameter. * @param onBeforeRun The function to be called with a `CatalogRunEvent`
* event target will be the catalog entity. onBeforeRun hook can call event.preventDefault() * event target will be the catalog entity. onBeforeRun hook can call event.preventDefault()
* to stop run sequence * to stop run sequence
* @returns A function to remove that hook * @returns A function to remove that hook