Update documentation for runtime events and metadata extraction#64
Open
phoyo008 wants to merge 17 commits intoortus-boxlang:v1.xfrom
Open
Update documentation for runtime events and metadata extraction#64phoyo008 wants to merge 17 commits intoortus-boxlang:v1.xfrom
phoyo008 wants to merge 17 commits intoortus-boxlang:v1.xfrom
Conversation
This reverts commit d35ac59.
This reverts commit 30a0910.
# Cache Object Store Events completed the documentation for this part
Pablo updates
Runtime Events, BIF & Component Lifecycle, Application & Request, Session, Template & Function Invocations, Serialization / Marshalling, Logging & Dump
Pablo updates Runtime Events, BIF & Component Lifecycle, Application & Request, Session, Template & Function Invocations, Serialization / Marshalling, Logging & Dump
lmajano
reviewed
Mar 13, 2026
lmajano
reviewed
Mar 13, 2026
lmajano
reviewed
Mar 13, 2026
Contributor
|
Few comments and we can merge |
Added new plugins to the configuration.
Contributor
|
@phoyo008 You have this many times in the examples but this is not proper syntax for BoxLang as we don't declare the class name there. Make these just be |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ten core interceptor event files were previously stubs — they listed event names but provided no information about what data each event carries, when it fires, or how to write a listener. This PR fully documents all of them with typed data payload tables and BoxLang listener examples.
All core interceptor event files follow a consistent three-part structure per event:
1. Event Description
Each event opens with a plain-language explanation of when it fires and what it is useful for. Example:
2. Files Updated
runtime-events.mdonRuntimeStart,onRuntimeShutdown,onRuntimeConfigurationLoad,onRuntimeBoxContextStartup,onServerScopeCreation,onConfigurationLoad,onConfigurationOverrideLoad,onParse,onMissingMappingapplication-events.mdonApplicationStart,onApplicationEnd,onSessionStart,onSessionEnd,onRequestStart,onRequestEnd,onAbort,onError,onMissingTemplaterequest-context-events.mdonRequestContextStart,onRequestContextEnd,onRequestContextClosetemplate-invocations.mdpreTemplateInvoke,postTemplateInvokefunction-invocations.mdpreFunctionInvoke,postFunctionInvokelife-cycle-events.mdonBIFInvoke,onComponentInvoke,onComponentCreate,onComponentDestroyobject-marshalling-events.mdbeforeObjectMarshallSerialize,afterObjectMarshallSerialize,beforeObjectMarshallDeserialize,afterObjectMarshallDeserializecache-object-store-events.mdonCacheObjectStoreSet,onCacheObjectStoreGet,onCacheObjectStoreDelete,onCacheObjectStoreClearlogging-events.mdlogMessagedump-events.mdonDump3. What Each File Now Contains
Every event section includes: