Skip to content
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.

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

docs: fix spelling and grammar mistakes in Event Object #738

Merged
merged 1 commit into from
Apr 25, 2024
Merged
Changes from all commits
Commits
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
16 changes: 8 additions & 8 deletions docs/1.guide/4.event.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ icon: material-symbols-light:data-object

> Event object carries an incoming request and context.

Everytime a new HTTP requerst comes, h3 internally create an Event object and passes it though event handlers until sending response.
Every time a new HTTP request comes, h3 internally creates an Event object and passes it though event handlers until sending the response.

An event is passed through all the lifecycle hooks and composable utils to use it as context.

Expand Down Expand Up @@ -41,7 +41,7 @@ The main properties of an event are:

### `event.node`

The `event.node` allows to access the native Node.js request and response. In runtimes other than Node.js/Bun, h3 makes a compatible shim using [unjs/unenv](https://unenv.unjs.io).
The `event.node` allows you to access the native Node.js request and response. In runtimes other than Node.js/Bun, h3 makes a compatible shim using [unjs/unenv](https://unenv.unjs.io).

> [!IMPORTANT]
> Try to **avoid** depending on `event.node.*` context as much as you can and instead prefer h3 utils.
Expand All @@ -55,23 +55,23 @@ defineEventHandler((event) => {

### `event.web?`

Only if available, it is an object with [`request`](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request) and [`url`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) propertiers to access native web request context.
If available, an object with [`request`](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request) and [`url`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) properties to access native web request context.

### `event.method`

Access to the normalized (uppercase) request [method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods).

### `event.path`

Access to the request request path. (**Example:** `/test?test=123`)
Access to the request path. (**Example:** `/test?test=123`)

- `context` with some context information about the request.
- `headers` with a **normalized version** of the headers of the request.
- `handled` with a boolean that indicates if the request has terminated.

### `event.headers`

Access tp the normalized request [Headers](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
Access to the normalized request [Headers](https://developer.mozilla.org/en-US/docs/Web/API/Headers).

> [!TIP]
> You can alternatively use `getHeaders(event)` or `getHeader(event, name)` for a simplified interface.
Expand All @@ -83,13 +83,13 @@ You can store your custom properties inside `event.context` to share across comp

### `event.handled`

Specifies if response is already handled or not. Initially for each request it is `false` and when a response is generated, it is set to `true`.
Specifies if response is already handled or not. Initially for each request it is `false`, and when a response is generated, it is set to `true`.

**Advanced:** If you manually handle the response, set it to `true` to tell h3 stop sending any responses.

## Methods

Actually, h3 provide a function to help you to create a response before the end of the request.
h3 provides a function to help you to create a response before the end of the request.

### `event.respondWith`

Expand All @@ -101,7 +101,7 @@ You must craft a response using the [`Response`](https://developer.mozilla.org/e
> Prefer explicit `return` over `respondWith` as best practice.

> [!IMPORTANT]
> A `responseWith` will **always** take precedence over the returned value, from current and next event handlers. If there is no returned value, the request will continue until the end of the stack runner.
> A `responseWith` call will **always** take precedence over the returned value, from current and next event handlers. If there is no returned value, the request will continue until the end of the stack runner.

**Example:**

Expand Down