Skip to content

Commit

Permalink
feat: utils to get and set response status
Browse files Browse the repository at this point in the history
  • Loading branch information
pi0 committed Dec 15, 2022
1 parent 6a146ad commit c8b4d85
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 19 deletions.
51 changes: 32 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,28 +39,32 @@ pnpm add h3
## Usage

```ts
import { createServer } from 'http'
import { createApp, eventHandler, toNodeListener } from 'h3'
import { createServer } from "node:http";
import { createApp, eventHandler, toNodeListener } from "h3";

const app = createApp()
app.use('/', eventHandler(() => 'Hello world!'))
const app = createApp();
app.use(
"/",
eventHandler(() => "Hello world!")
);

createServer(toNodeListener(app)).listen(process.env.PORT || 3000)
createServer(toNodeListener(app)).listen(process.env.PORT || 3000);
```

<details>
<summary>Example using <a href="https://github.com/unjs/listhen">listhen</a> for an elegant listener.</summary>
Example using <a href="https://github.com/unjs/listhen">listhen</a> for an elegant listener:

```ts
import { createApp, toNodeListener } from 'h3'
import { listen } from 'listhen'
import { createApp, eventHandler, toNodeListener } from "h3";
import { listen } from "listhen";

const app = createApp()
app.use('/', eventHandler(() => 'Hello world!'))
const app = createApp();
app.use(
"/",
eventHandler(() => "Hello world!")
);

listen(toNodeListener(app))
listen(toNodeListener(app));
```
</details>

## Router

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

```ts
import { createApp, eventHandler, createRouter } from 'h3'
import { createApp, eventHandler, createRouter } from "h3";

const app = createApp()
const app = createApp();

const router = createRouter()
.get('/', eventHandler(() => 'Hello World!'))
.get('/hello/:name', eventHandler(event => `Hello ${event.context.params.name}!`))

app.use(router)
.get(
"/",
eventHandler(() => "Hello World!")
)
.get(
"/hello/:name",
eventHandler((event) => `Hello ${event.context.params.name}!`)
);

app.use(router);
```

**Tip:** We can register same route more than once with different methods.
Expand Down Expand Up @@ -138,6 +148,9 @@ H3 has concept of compasable utilities that accept `event` (from `eventHandler((
- `createError({ statusCode, statusMessage, data? })`
- `sendProxy(event, { target, headers?, fetchOptions?, fetch?, sendStream? })`
- `proxyRequest(event, { target, headers?, fetchOptions?, fetch?, sendStream? })`
- `setResponseStatus(event, status)`
- `getResponseStatus(event)`
- `getResponseStatusText(event)`
👉 You can learn more about usage in [JSDocs Documentation](https://www.jsdocs.io/package/h3#package-functions).
Expand Down
19 changes: 19 additions & 0 deletions src/utils/response.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,25 @@ export function send(event: H3Event, data?: any, type?: string): Promise<void> {
});
}

export function setResponseStatus(
event: H3Event,
code: number,
text?: string
): void {
event.node.res.statusCode = code;
if (text) {
event.node.res.statusMessage = text;
}
}

export function getResponseStatus(event: H3Event): number {
return event.node.res.statusCode;
}

export function getResponseStatusText(event: H3Event): string {
return event.node.res.statusMessage;
}

export function defaultContentType(event: H3Event, type?: string) {
if (type && !event.node.res.getHeader("content-type")) {
event.node.res.setHeader("content-type", type);
Expand Down

0 comments on commit c8b4d85

Please sign in to comment.