Mirroristas/pockethost
2
0
Fork 0
mirror of https://github.com/pockethost/pockethost.git synced 2025-06-07 14:46:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(pockethost): added action docs

Browse Source
This commit is contained in:
Ben Allfree 2024-06-27 00:36:15 -07:00
parent 20b97cdc24
commit ac63ea72b7
2 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.changeset/rare-lions-boil.md Normal file
View File

@ -0,0 +1,5 @@
---
'pockethost': patch
---
Updated plugin documentation

10
packages/pockethost/plugin-guide.md
View File

@ -42,4 +42,14 @@ A plugin is an npm package. Run `pockethost plugin create <my-plugin-name>` to c
## Core Actions ## Core Actions
| Name | Description | Context | Example | Since |
| --------------------- | ----------------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| BeforeInstanceStarted | An instance will start | instance | [example](https://github.com/pockethost/pockethost/blob/e6355c1aea2484ffba9d95110faa2af40e922855/packages/plugin-launcher-spawn/src/index.ts#L215) | 1.3.0 |
| AfterInstanceStarted | An instance has started | instance, url | [example](https://github.com/pockethost/pockethost/blob/e6355c1aea2484ffba9d95110faa2af40e922855/packages/plugin-launcher-spawn/src/index.ts#L215) | 1.3.0 |
| AfterInstanceStopped | An instance has stopped | instance, url | [example](https://github.com/pockethost/pockethost/blob/e6355c1aea2484ffba9d95110faa2af40e922855/packages/plugin-launcher-spawn/src/index.ts#L199) | 1.3.0 |
| InstanceLog | A log action | logLevel, currentLogLevel, args | [example](https://github.com/pockethost/pockethost/blob/e6355c1aea2484ffba9d95110faa2af40e922855/packages/plugin-launcher-spawn/src/index.ts#L147) | 1.3.0 |
## Core Filters ## Core Filters
| Name | Description | Context | Since |
| ---- | ----------- | ------- | ----- |