Skip to content

Commit

Permalink
errrefguide
Browse files Browse the repository at this point in the history
  • Loading branch information
jacoobes committed Jan 13, 2025
1 parent 21f7072 commit b4284e4
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions src/content/docs/v4/reference/error-handling.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
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**.

:::

0 comments on commit b4284e4

Please sign in to comment.