Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs about adding error handlers #531

Merged
merged 1 commit into from
Feb 6, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions website/docs/library/queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,27 @@ singleton throughout your code.
- `schema` can be used to change the default `graphile_worker` schema to
something else (equivalent to `--schema` on the CLI)

:::warning If you use `pgPool`, ensure it has error handlers!

If your `pgPool` doesn't have error handlers then connection issues with the
database may cause your Worker process to exit prematurely.

```ts
import { Pool } from "pg";
const pool = new Pool({
/* ... */
});

/* highlight-start */
// No action necessary
function handleError() {}
pool.on("error", handleError);
pool.on("connect", (client) => void client.on("error", handleError));
/* highlight-end */
```

:::

## `WorkerUtils`

A `WorkerUtils` instance has the following methods:
Expand Down
Loading