Skip to content

Commit c8b4d85

Browse files
committed
feat: utils to get and set response status
1 parent 6a146ad commit c8b4d85

File tree

2 files changed

+51
-19
lines changed

2 files changed

+51
-19
lines changed

Diff for: README.md

+32-19
Original file line numberDiff line numberDiff line change
@@ -39,28 +39,32 @@ pnpm add h3
3939
## Usage
4040

4141
```ts
42-
import { createServer } from 'http'
43-
import { createApp, eventHandler, toNodeListener } from 'h3'
42+
import { createServer } from "node:http";
43+
import { createApp, eventHandler, toNodeListener } from "h3";
4444

45-
const app = createApp()
46-
app.use('/', eventHandler(() => 'Hello world!'))
45+
const app = createApp();
46+
app.use(
47+
"/",
48+
eventHandler(() => "Hello world!")
49+
);
4750

48-
createServer(toNodeListener(app)).listen(process.env.PORT || 3000)
51+
createServer(toNodeListener(app)).listen(process.env.PORT || 3000);
4952
```
5053

51-
<details>
52-
<summary>Example using <a href="https://github.com/unjs/listhen">listhen</a> for an elegant listener.</summary>
54+
Example using <a href="https://github.com/unjs/listhen">listhen</a> for an elegant listener:
5355

5456
```ts
55-
import { createApp, toNodeListener } from 'h3'
56-
import { listen } from 'listhen'
57+
import { createApp, eventHandler, toNodeListener } from "h3";
58+
import { listen } from "listhen";
5759

58-
const app = createApp()
59-
app.use('/', eventHandler(() => 'Hello world!'))
60+
const app = createApp();
61+
app.use(
62+
"/",
63+
eventHandler(() => "Hello world!")
64+
);
6065

61-
listen(toNodeListener(app))
66+
listen(toNodeListener(app));
6267
```
63-
</details>
6468

6569
## Router
6670

@@ -69,15 +73,21 @@ The `app` instance created by `h3` uses a middleware stack (see [how it works](#
6973
To opt-in using a more advanced and convenient routing system, we can create a router instance and register it to app instance.
7074

7175
```ts
72-
import { createApp, eventHandler, createRouter } from 'h3'
76+
import { createApp, eventHandler, createRouter } from "h3";
7377

74-
const app = createApp()
78+
const app = createApp();
7579

7680
const router = createRouter()
77-
.get('/', eventHandler(() => 'Hello World!'))
78-
.get('/hello/:name', eventHandler(event => `Hello ${event.context.params.name}!`))
79-
80-
app.use(router)
81+
.get(
82+
"/",
83+
eventHandler(() => "Hello World!")
84+
)
85+
.get(
86+
"/hello/:name",
87+
eventHandler((event) => `Hello ${event.context.params.name}!`)
88+
);
89+
90+
app.use(router);
8191
```
8292

8393
**Tip:** We can register same route more than once with different methods.
@@ -138,6 +148,9 @@ H3 has concept of compasable utilities that accept `event` (from `eventHandler((
138148
- `createError({ statusCode, statusMessage, data? })`
139149
- `sendProxy(event, { target, headers?, fetchOptions?, fetch?, sendStream? })`
140150
- `proxyRequest(event, { target, headers?, fetchOptions?, fetch?, sendStream? })`
151+
- `setResponseStatus(event, status)`
152+
- `getResponseStatus(event)`
153+
- `getResponseStatusText(event)`
141154
142155
👉 You can learn more about usage in [JSDocs Documentation](https://www.jsdocs.io/package/h3#package-functions).
143156

Diff for: src/utils/response.ts

+19
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,25 @@ export function send(event: H3Event, data?: any, type?: string): Promise<void> {
1919
});
2020
}
2121

22+
export function setResponseStatus(
23+
event: H3Event,
24+
code: number,
25+
text?: string
26+
): void {
27+
event.node.res.statusCode = code;
28+
if (text) {
29+
event.node.res.statusMessage = text;
30+
}
31+
}
32+
33+
export function getResponseStatus(event: H3Event): number {
34+
return event.node.res.statusCode;
35+
}
36+
37+
export function getResponseStatusText(event: H3Event): string {
38+
return event.node.res.statusMessage;
39+
}
40+
2241
export function defaultContentType(event: H3Event, type?: string) {
2342
if (type && !event.node.res.getHeader("content-type")) {
2443
event.node.res.setHeader("content-type", type);

0 commit comments

Comments
 (0)