Skip to content

Commit

Permalink
docs: fix remix example
Browse files Browse the repository at this point in the history
  • Loading branch information
TomerAberbach committed Apr 10, 2024
1 parent 4e17d8c commit 0b4ffed
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 10 deletions.
16 changes: 8 additions & 8 deletions docs/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ with a status code for the redirection.

#### Defined in

[index.ts:208](https://github.com/TomerAberbach/redirect-url/blob/ee59f174f88b7e69799cd2c707fd833365fd70df/src/index.ts#L208)
[index.ts:208](https://github.com/TomerAberbach/redirect-url/blob/4e17d8c2edc6dabcdfc2797cee7b1caf9ada3364/src/index.ts#L208)

---

Expand All @@ -53,7 +53,7 @@ See `ObjectRedirect` for more information.

#### Defined in

[index.ts:194](https://github.com/TomerAberbach/redirect-url/blob/ee59f174f88b7e69799cd2c707fd833365fd70df/src/index.ts#L194)
[index.ts:194](https://github.com/TomerAberbach/redirect-url/blob/4e17d8c2edc6dabcdfc2797cee7b1caf9ada3364/src/index.ts#L194)

---

Expand Down Expand Up @@ -81,7 +81,7 @@ status code for the redirection, or null if no mapping exists for the input URL.

#### Defined in

[index.ts:292](https://github.com/TomerAberbach/redirect-url/blob/ee59f174f88b7e69799cd2c707fd833365fd70df/src/index.ts#L292)
[index.ts:292](https://github.com/TomerAberbach/redirect-url/blob/4e17d8c2edc6dabcdfc2797cee7b1caf9ada3364/src/index.ts#L292)

---

Expand All @@ -104,7 +104,7 @@ All properties are optional.

#### Defined in

[index.ts:253](https://github.com/TomerAberbach/redirect-url/blob/ee59f174f88b7e69799cd2c707fd833365fd70df/src/index.ts#L253)
[index.ts:253](https://github.com/TomerAberbach/redirect-url/blob/4e17d8c2edc6dabcdfc2797cee7b1caf9ada3364/src/index.ts#L253)

---

Expand All @@ -123,7 +123,7 @@ The result of computing a redirect for a URL.

#### Defined in

[index.ts:279](https://github.com/TomerAberbach/redirect-url/blob/ee59f174f88b7e69799cd2c707fd833365fd70df/src/index.ts#L279)
[index.ts:279](https://github.com/TomerAberbach/redirect-url/blob/4e17d8c2edc6dabcdfc2797cee7b1caf9ada3364/src/index.ts#L279)

---

Expand All @@ -138,7 +138,7 @@ See `ObjectRedirect` for more information.

#### Defined in

[index.ts:202](https://github.com/TomerAberbach/redirect-url/blob/ee59f174f88b7e69799cd2c707fd833365fd70df/src/index.ts#L202)
[index.ts:202](https://github.com/TomerAberbach/redirect-url/blob/4e17d8c2edc6dabcdfc2797cee7b1caf9ada3364/src/index.ts#L202)

## Functions

Expand Down Expand Up @@ -172,7 +172,7 @@ See [Redirect](modules.md#redirect) for how to specify redirects and

#### Defined in

[index.ts:106](https://github.com/TomerAberbach/redirect-url/blob/ee59f174f88b7e69799cd2c707fd833365fd70df/src/index.ts#L106)
[index.ts:106](https://github.com/TomerAberbach/redirect-url/blob/4e17d8c2edc6dabcdfc2797cee7b1caf9ada3364/src/index.ts#L106)

---

Expand Down Expand Up @@ -228,4 +228,4 @@ See [Redirect](modules.md#redirect) for how to specify redirects and

#### Defined in

[index.ts:56](https://github.com/TomerAberbach/redirect-url/blob/ee59f174f88b7e69799cd2c707fd833365fd70df/src/index.ts#L56)
[index.ts:56](https://github.com/TomerAberbach/redirect-url/blob/4e17d8c2edc6dabcdfc2797cee7b1caf9ada3364/src/index.ts#L56)
4 changes: 3 additions & 1 deletion docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,13 @@ app.all(`*`, redirectsMiddleware)

[**entry.server**](https://remix.run/docs/en/main/file-conventions/entry.server):

<!-- eslint-disable consistent-return -->

```js
export const handleDocumentRequest = request => {
const result = redirectUrl(request.url)
if (result) {
throw redirect(result.url, result.status)
return redirect(result.url, result.status)
}

// ...
Expand Down
4 changes: 3 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,13 @@ app.all(`*`, redirectsMiddleware)

[**entry.server**](https://remix.run/docs/en/main/file-conventions/entry.server):

<!-- eslint-disable consistent-return -->

```js
export const handleDocumentRequest = request => {
const result = redirectUrl(request.url)
if (result) {
throw redirect(result.url, result.status)
return redirect(result.url, result.status)
}

// ...
Expand Down

0 comments on commit 0b4ffed

Please sign in to comment.