Merge pull request #76 from sern-handler/error-handling-ref
Some checks are pending
Deploy to GitHub Pages / Deploy to GitHub Pages (push) Waiting to run

errrefguide
This commit is contained in:
Jacob Nguyen
2025-01-12 22:43:37 -06:00
committed by GitHub
2 changed files with 60 additions and 1 deletions

View File

@@ -2,7 +2,7 @@
title: Conclusion
description: Thank you for reading the sern guide
sidebar:
order: 9
order: 10
---
If you reached this far, thank you for reading!

View File

@@ -0,0 +1,59 @@
---
title: Error handling
description: Properly handle unexpected errors.
sidebar:
order: 9
---
Error handling is important in any application, especially one which has a long lifetime of running.
## Handling errors in command and event modules
To capture errors, enable the 'error' event in sern's global event manager.
import { FileTree } from '@astrojs/starlight/components';
<FileTree>
- src/
- commands/
- events/
- **error.js**
- index.js
- config.js
- dependencies.d.ts
</FileTree>
:::tip
Don't forget to enable event handling!
```js title='src/config.js'
export const events = "./dist/events"
```
:::
```js
import { EventType, eventModule } from '@sern/handler'
export default eventModule({
type: EventType.Sern,
name: 'error',
execute: (err) => {
console.log('caught', err)
}
})
```
If the error handler is not set, sern's behavior is to crash the application.
This respects [node.js's default behavior](https://nodejs.org/api/events.html#error-events)
:::caution
Be careful about errors thrown IN the error handler.
If this happens, a memory leaks occurs and your bot **will crash**.
:::