Skip to content

chore(gatsby): add generic to GatsbyFunctionRequest #35029

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 14, 2022
Merged

chore(gatsby): add generic to GatsbyFunctionRequest #35029

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b8eba15
add generic to GatsbyFunctionRequest
mckelveygreg Mar 2, 2022
d4caa32
Merge remote-tracking branch 'upstream/master' into fix/add-generic-t…
Mar 3, 2022
e01a857
change GatsbyFunctionRequest type body to follow express pattern
mckelveygreg Mar 11, 2022
deb6ae6
update Gatsby function typescript example docs
mckelveygreg Mar 11, 2022
69b1a89
Merge remote-tracking branch 'upstream/master' into fix/add-generic-t…
Mar 14, 2022
a5145c4
Update getting-started.md
LekoArts Mar 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/docs/reference/functions/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,15 @@ Functions can be written in JavaScript or Typescript.
```ts:title=src/api/typescript.ts
import { GatsbyFunctionRequest, GatsbyFunctionResponse } from "gatsby"

interface ContactBody {
message: string
}

export default function handler(
req: GatsbyFunctionRequest,
req: GatsbyFunctionRequest<ContactBody>,
res: GatsbyFunctionResponse
) {
res.send(`I am TYPESCRIPT`)
res.send({ title: `I am TYPESCRIPT`, message: req.body.message })
}
```

Expand Down
4 changes: 2 additions & 2 deletions packages/gatsby/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1648,7 +1648,7 @@ export interface GatsbyFunctionResponse<T = any> extends ServerResponse {
/**
* Gatsby function route request
*/
export interface GatsbyFunctionRequest extends IncomingMessage {
export interface GatsbyFunctionRequest<ReqBody = any> extends IncomingMessage {
/**
* Object of values from URL query parameters (after the ? in the URL)
*/
Expand All @@ -1658,7 +1658,7 @@ export interface GatsbyFunctionRequest extends IncomingMessage {
* Object of values from route parameters
*/
params: Record<string, string>
body: any
body: ReqBody
/**
* Object of `cookies` from header
*/
Expand Down