-
Notifications
You must be signed in to change notification settings - Fork 213
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add event handler generics for typed request body and query (#417)
Co-authored-by: Pooya Parsa <pooya@pi0.io>
- Loading branch information
Showing
10 changed files
with
192 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,3 +6,4 @@ coverage | |
.profile | ||
.idea | ||
.eslintcache | ||
tsconfig.vitest-temp.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
import { describe, it, expectTypeOf } from "vitest"; | ||
import type { QueryObject } from "ufo"; | ||
import { | ||
eventHandler, | ||
H3Event, | ||
getQuery, | ||
readBody, | ||
readValidatedBody, | ||
getValidatedQuery, | ||
} from "../src"; | ||
|
||
describe("types", () => { | ||
describe("eventHandler", () => { | ||
it("return type (inferred)", () => { | ||
const handler = eventHandler(() => { | ||
return { | ||
foo: "bar", | ||
}; | ||
}); | ||
const response = handler({} as H3Event); | ||
expectTypeOf(response).toEqualTypeOf<{ foo: string }>(); | ||
}); | ||
|
||
it("return type (simple generic)", () => { | ||
const handler = eventHandler<string>(() => { | ||
return ""; | ||
}); | ||
const response = handler({} as H3Event); | ||
expectTypeOf(response).toEqualTypeOf<string>(); | ||
}); | ||
}); | ||
|
||
describe("readBody", () => { | ||
it("untyped", () => { | ||
eventHandler(async (event) => { | ||
const body = await readBody(event); | ||
// TODO: Default to unknown in next major version | ||
expectTypeOf(body).toBeAny(); | ||
}); | ||
}); | ||
|
||
it("typed via generic", () => { | ||
eventHandler(async (event) => { | ||
const body = await readBody<string>(event); | ||
expectTypeOf(body).not.toBeAny(); | ||
expectTypeOf(body).toBeString(); | ||
}); | ||
}); | ||
|
||
it("typed via validator", () => { | ||
eventHandler(async (event) => { | ||
// eslint-disable-next-line unicorn/consistent-function-scoping | ||
const validator = (body: unknown) => body as { id: string }; | ||
const body = await readValidatedBody(event, validator); | ||
expectTypeOf(body).not.toBeAny(); | ||
expectTypeOf(body).toEqualTypeOf<{ id: string }>(); | ||
}); | ||
}); | ||
|
||
it("typed via event handler", () => { | ||
eventHandler<{ body: { id: string } }>(async (event) => { | ||
const body = await readBody(event); | ||
expectTypeOf(body).not.toBeAny(); | ||
expectTypeOf(body).toEqualTypeOf<{ id: string }>(); | ||
}); | ||
}); | ||
}); | ||
|
||
describe("getQuery", () => { | ||
it("untyped", () => { | ||
eventHandler((event) => { | ||
const query = getQuery(event); | ||
expectTypeOf(query).not.toBeAny(); | ||
expectTypeOf(query).toEqualTypeOf<QueryObject>(); | ||
}); | ||
}); | ||
|
||
it("typed via generic", () => { | ||
eventHandler((event) => { | ||
const query = getQuery<{ id: string }>(event); | ||
expectTypeOf(query).not.toBeAny(); | ||
expectTypeOf(query).toEqualTypeOf<{ id: string }>(); | ||
}); | ||
}); | ||
|
||
it("typed via validator", () => { | ||
eventHandler(async (event) => { | ||
// eslint-disable-next-line unicorn/consistent-function-scoping | ||
const validator = (body: unknown) => body as { id: string }; | ||
const body = await getValidatedQuery(event, validator); | ||
expectTypeOf(body).not.toBeAny(); | ||
expectTypeOf(body).toEqualTypeOf<{ id: string }>(); | ||
}); | ||
}); | ||
|
||
it("typed via event handler", () => { | ||
eventHandler<{ query: { id: string } }>((event) => { | ||
const query = getQuery(event); | ||
expectTypeOf(query).not.toBeAny(); | ||
expectTypeOf(query).toEqualTypeOf<{ id: string }>(); | ||
}); | ||
}); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters