Skip to content

Commit

Permalink
docs(events): add events listner options
Browse files Browse the repository at this point in the history
  • Loading branch information
koreanddinghwan committed Oct 18, 2023
1 parent f07a58a commit 80f06ac
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion content/techniques/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,30 @@ handleOrderCreatedEvent(payload: OrderCreatedEvent) {

> warning **Warning** Event subscribers cannot be request-scoped.
The first argument can be a `string` or `symbol` for a simple event emitter and a `string | symbol | Array<string | symbol>` in a case of a wildcard emitter. The second argument (optional) is a listener options object ([read more](https://github.com/EventEmitter2/EventEmitter2#emitteronevent-listener-options-objectboolean)).
The first argument can be a `string` or `symbol` for a simple event emitter and a `string | symbol | Array<string | symbol>` in a case of a wildcard emitter.

The second argument (optional) is a listener options object as follows:


```typescript
export type OnEventOptions = OnOptions & {
/**
* If "true", prepends (instead of append) the given listener to the array of listeners.
*
* @see https://github.com/EventEmitter2/EventEmitter2#emitterprependlistenerevent-listener-options
*
* @default false
*/
prependListener?: boolean;

/**
* If "true", the onEvent callback will not throw an error while handling the event. Otherwise, if "false" it will throw an error.
*
* @default true
*/
suppressErrors?: boolean;
};
```

```typescript
@OnEvent('order.created', { async: true })
Expand All @@ -94,6 +117,9 @@ handleOrderCreatedEvent(payload: OrderCreatedEvent) {
}
```

> info **Hint** read more about ([listener options object](https://github.com/EventEmitter2/EventEmitter2#emitteronevent-listener-options-objectboolean)).

To use namespaces/wildcards, pass the `wildcard` option into the `EventEmitterModule#forRoot()` method. When namespaces/wildcards are enabled, events can either be strings (`foo.bar`) separated by a delimiter or arrays (`['foo', 'bar']`). The delimiter is also configurable as a configuration property (`delimiter`). With namespaces feature enabled, you can subscribe to events using a wildcard:

```typescript
Expand Down

0 comments on commit 80f06ac

Please sign in to comment.