Skip to content

Commit 34edb29

Browse files
committed
docs: update docs
1 parent 10bdfbe commit 34edb29

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ await loadEventHandlers(processEventsFolder, process, {
5454
// Default value: default
5555
exportType: "named",
5656
// Default value: concurrent
57-
importMode: "sequential",
57+
processMode: "sequential",
5858
// Default value: "eventHandler"
59-
preferredNamedExport: "handler",
59+
preferredExportName: "handler",
6060
// Default value: { name: "name", isOnce: "isOnce", isPrepend: "isPrepend", execute: "execute" }
6161
preferredEventHandlerKeys: { name: "eventName", isOnce: "once", isPrepend: "prepend", execute: "run" },
6262
// Default value: []
@@ -79,13 +79,13 @@ process.emit("uncaughtException", new Error("MyDeadlyError"));
7979

8080
#### Creating Event Handlers
8181

82-
With `exportType: named`, it'll look for exports with a specific configured `preferredNamedExport: handler` in this example. It's `eventHandler` by default.
82+
With `exportType: named`, it'll look for exports with a specific configured `preferredExportName: handler` in this example. It's `eventHandler` by default.
8383

8484
```ts
8585
// src/eventHandlers/process/named.ts
8686

8787
// exportType: named
88-
// preferredNamedExport: handler
88+
// preferredExportName: handler
8989
export const handler = {
9090
// Keys follow as configured preferredEventHandlerKeys: { name: "eventName", isOnce: "once", isPrepend: "prepend", execute: "run" }
9191
eventName: "uncaughtException",
@@ -111,7 +111,7 @@ With `exportType: default`, it'll look for default exports exclusively, so you'l
111111
// src/eventHandlers/process/default.ts
112112

113113
// exportType: default
114-
// (ignored) preferredNamedExport: handler (preferredNamedExport is ignored because it's configured to find default exports only)
114+
// (ignored) preferredExportName: handler (preferredExportName is ignored because it's configured to find default exports only)
115115
export default {
116116
// Keys follow as configured preferredEventHandlerKeys: { name: "eventName", isOnce: "once", isPrepend: "prepend", execute: "run" }
117117
eventName: "uncaughtException",
@@ -202,7 +202,7 @@ await loadEventHandlers("./path/to/eventHandlers", objectWithEventEmitterMethods
202202
// Default value: concurrent
203203
// Options: "concurrent" or "sequential"
204204
// How the module imports event handlers
205-
importMode: "sequential",
205+
processMode: "sequential",
206206
// Default value: default
207207
// Options: "default" or "named"
208208
// The type of export the module should look for in a directory. One export type per directory.
@@ -214,7 +214,7 @@ await loadEventHandlers("./path/to/eventHandlers", objectWithEventEmitterMethods
214214
// follows the event handler structure regardless of how they're named.
215215
// Preferred export name to look for inside a module.
216216
// Setting exportType: "default" will ignore this option as "default"
217-
preferredNamedExport: "myCustomEventHandler",
217+
preferredExportName: "myCustomEventHandler",
218218
// Default value: { name: "name", isOnce: "isOnce", isPrepend: "isPrepend", execute: "execute" }
219219
// Preferred key names to look for within the exported object
220220
preferredEventHandlerKeys: {
@@ -258,9 +258,9 @@ const processEvents = nodePath.join(eventHandlersFolder, "process");
258258

259259
await loadEventHandlers(processEvents, process, {
260260
exportType: "named",
261-
importMode: "concurrent",
261+
processMode: "concurrent",
262262
// Import all named exports from all modules in a directory together with exportType: "named"
263-
preferredNamedExport: "*",
263+
preferredExportName: "*",
264264
listenerPrependedArgs: ["myString", { number: 1 }],
265265
});
266266

0 commit comments

Comments
 (0)