Skip to content

Commit fead46f

Browse files
authored
fix(types): mark type parameters as optional (#1101)
Some types which end-users could be using, declare the type parameters as requried, when in fact they are entirely optional. This arises when users try to use the event handler code on it's own
1 parent d0d5268 commit fead46f

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

src/event-handler/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import {
1616
import { receiverHandle as receive } from "./receive.js";
1717
import { removeListener } from "./remove-listener.js";
1818

19-
export interface EventHandler<TTransformed> {
19+
export interface EventHandler<TTransformed = unknown> {
2020
on<E extends EmitterWebhookEventName>(
2121
event: E | E[],
2222
callback: HandlerFunction<E, TTransformed>,
@@ -38,7 +38,7 @@ export interface EventHandler<TTransformed> {
3838
receive(event: EmitterWebhookEvent | WebhookError): Promise<void>;
3939
}
4040

41-
export function createEventHandler<TTransformed>(
41+
export function createEventHandler<TTransformed = unknown>(
4242
options: Options<TTransformed>,
4343
): EventHandler<TTransformed> {
4444
const state: State = {

src/types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ type TransformMethod<T> = (event: EmitterWebhookEvent) => T | PromiseLike<T>;
4747

4848
export type HandlerFunction<
4949
TName extends EmitterWebhookEventName,
50-
TTransformed,
50+
TTransformed = unknown,
5151
> = (event: EmitterWebhookEvent<TName> & TTransformed) => any;
5252

5353
export type RemoveHandlerFunction<
5454
TName extends EmitterWebhookEventName | "*",
55-
TTransformed,
55+
TTransformed = unknown,
5656
> = (event: EmitterWebhookEvent<Exclude<TName, "*">> & TTransformed) => any;
5757

5858
type Hooks = {

0 commit comments

Comments
 (0)