Skip to content

Commit

Permalink
Update options in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
benjie committed Dec 6, 2024
1 parent 1c1fcf2 commit b0fea01
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions website/docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ Here are the options under the `worker` key as defined by
crontabFile?: string;
events?: WorkerEvents;
fileExtensions?: string[];
getQueueNameBatchDelay?: number;
gracefulShutdownAbortTimeout?: number;
logger?: Logger<{}>;
maxPoolSize?: number;
Expand All @@ -103,7 +104,8 @@ Number of jobs to run concurrently.

Type: `string | undefined`

Database [connection string](./connection-string.md).
Database
[connection string](https://worker.graphile.org/docs/connection-string).

### worker.crontabFile

Expand All @@ -116,7 +118,7 @@ Override path to crontab file.
Type: `WorkerEvents | undefined`

A Node.js `EventEmitter` that exposes certain events within the runner (see
[`WorkerEvents`](/docs/worker-events)).
[`WorkerEvents`](https://worker.graphile.org/docs/worker-events)).

### worker.fileExtensions

Expand All @@ -126,6 +128,16 @@ A list of file extensions (in priority order) that Graphile Worker should
attempt to import directly when loading tasks. Defaults to
`[".js", ".cjs", ".mjs"]`.

### worker.getQueueNameBatchDelay

Type: `number | undefined`

**Experimental**

When getting a queue name in a job, we batch calls for efficiency. By default we
do this over a 50ms window; increase this for greater efficiency, reduce this to
reduce the latency for getting an individual queue name.

### worker.gracefulShutdownAbortTimeout

Type: `number | undefined`
Expand Down

0 comments on commit b0fea01

Please sign in to comment.