Skip to content

Commit d46128c

Browse files
committed
Add blank line between each documented option
1 parent 1a77888 commit d46128c

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

src/index.ts

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,19 @@ declare global {
3737
interface Tasks {
3838
/* extend this through declaration merging */
3939
}
40+
4041
interface MigrateEvent {
4142
/**
4243
* The client used to run the migration. Replacing this is not officially
4344
* supported, but...
4445
*/
4546
client: PoolClient;
47+
4648
/**
4749
* The Postgres version number, e.g. 120000 for PostgreSQL 12.0
4850
*/
4951
readonly postgresVersion: number;
52+
5053
/**
5154
* Somewhere to store temporary data from plugins, only used during
5255
* premigrate, postmigrate, prebootstrap and postbootstrap
@@ -63,6 +66,7 @@ declare global {
6366
* @defaultValue `process.env.DATABASE_URL`
6467
*/
6568
connectionString?: string;
69+
6670
/**
6771
* Maximum number of concurrent connections to Postgres; must be at least
6872
* `2`. This number can be lower than `concurrentJobs`, however a low
@@ -75,17 +79,20 @@ declare global {
7579
* @defaultValue `10`
7680
*/
7781
maxPoolSize?: number;
82+
7883
/**
7984
*
8085
* @defaultValue `2000` */
8186
pollInterval?: number;
87+
8288
/**
8389
* Whether Graphile Worker should use prepared statements. Set `false` if
8490
* you use software (e.g. some Postgres pools) that don't support them.
8591
*
8692
* @defaultValue `true`
8793
*/
8894
preparedStatements?: boolean;
95+
8996
/**
9097
* The database schema in which Graphile Worker's tables, functions,
9198
* views, etc are located. Graphile Worker will create or edit things in
@@ -94,13 +101,15 @@ declare global {
94101
* @defaultValue `graphile_worker`
95102
*/
96103
schema?: string;
104+
97105
/**
98106
* The path to a directory in which Graphile Worker should look for task
99107
* executors.
100108
*
101109
* @defaultValue `process.cwd() + "/tasks"`
102110
*/
103111
taskDirectory?: string;
112+
104113
/**
105114
* The path to a file in which Graphile Worker should look for crontab
106115
* schedules. See: [recurring tasks
@@ -109,13 +118,15 @@ declare global {
109118
* @defaultValue `process.cwd() + "/crontab"`
110119
*/
111120
crontabFile?: string;
121+
112122
/**
113123
* Number of jobs to run concurrently on a single Graphile Worker
114124
* instance.
115125
*
116126
* @defaultValue `1`
117127
*/
118128
concurrentJobs?: number;
129+
119130
/**
120131
* A list of file extensions (in priority order) that Graphile Worker
121132
* should attempt to import directly when loading task executors from the
@@ -124,6 +135,7 @@ declare global {
124135
* @defaultValue `[".js", ".cjs", ".mjs"]`
125136
*/
126137
fileExtensions?: string[];
138+
127139
/**
128140
* How long in milliseconds after a gracefulShutdown is triggered should
129141
* Graphile Worker wait to trigger the AbortController, which should
@@ -132,6 +144,7 @@ declare global {
132144
* @defaultValue `5_000`
133145
*/
134146
gracefulShutdownAbortTimeout?: number;
147+
135148
/**
136149
* Set to `true` to use the time as recorded by Node.js rather than
137150
* PostgreSQL. It's strongly recommended that you ensure the Node.js and
@@ -140,6 +153,7 @@ declare global {
140153
* @defaultValue `false`
141154
*/
142155
useNodeTime?: boolean;
156+
143157
/**
144158
* **Experimental**
145159
*
@@ -151,6 +165,7 @@ declare global {
151165
* @defaultValue `480_000`
152166
*/
153167
minResetLockedInterval?: number;
168+
154169
/**
155170
* **Experimental**
156171
*
@@ -161,6 +176,7 @@ declare global {
161176
* @defaultValue `600_000`
162177
*/
163178
maxResetLockedInterval?: number;
179+
164180
/**
165181
* **Experimental**
166182
*
@@ -172,10 +188,12 @@ declare global {
172188
* @defaultValue `50`
173189
*/
174190
getQueueNameBatchDelay?: number;
191+
175192
/**
176193
* A Logger instance (see [Logger](https://worker.graphile.org/docs/library/logger)).
177194
*/
178195
logger?: Logger;
196+
179197
/**
180198
* Provide your own Node.js `EventEmitter` in order to be able to receive
181199
* events (see
@@ -186,6 +204,7 @@ declare global {
186204
*/
187205
events?: WorkerEvents;
188206
}
207+
189208
interface Preset {
190209
worker?: WorkerOptions;
191210
}
@@ -201,6 +220,7 @@ declare global {
201220
};
202221
};
203222
}
223+
204224
interface WorkerHooks {
205225
/**
206226
* Called when Graphile Worker starts up.
@@ -244,11 +264,13 @@ declare global {
244264
* this task identifier (see `details`), you should set it.
245265
*/
246266
handler?: Task;
267+
247268
/**
248269
* The string that will identify this task (inferred from the file
249270
* path).
250271
*/
251272
readonly taskIdentifier: string;
273+
252274
/**
253275
* A list of the files (and associated metadata) that match this task
254276
* identifier.

0 commit comments

Comments
 (0)