From b9140ed40b8c333ccf37dd7b71e998bcfa1e5ee8 Mon Sep 17 00:00:00 2001 From: Tim Neutkens Date: Thu, 27 Oct 2022 15:07:59 -0700 Subject: [PATCH] Add never return type for redirect() and notFound() (#42009) Ensures cases like this work: ``` function username(user: null | User) { if (!user) redirect(); return user.name; } ``` ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have a helpful link attached, see `contributing.md` ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have a helpful link attached, see `contributing.md` ## Documentation / Examples - [ ] Make sure the linting passes by running `pnpm lint` - [ ] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md) --- packages/next/client/components/not-found.ts | 2 +- packages/next/client/components/redirect.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/next/client/components/not-found.ts b/packages/next/client/components/not-found.ts index e5cad6a30139412..2ca5e894be9bbfa 100644 --- a/packages/next/client/components/not-found.ts +++ b/packages/next/client/components/not-found.ts @@ -1,6 +1,6 @@ export const NOT_FOUND_ERROR_CODE = 'NEXT_NOT_FOUND' -export function notFound() { +export function notFound(): never { // eslint-disable-next-line no-throw-literal const error = new Error(NOT_FOUND_ERROR_CODE) ;(error as any).digest = NOT_FOUND_ERROR_CODE diff --git a/packages/next/client/components/redirect.ts b/packages/next/client/components/redirect.ts index 0b500ae87256f3f..5e685f94edbe0d9 100644 --- a/packages/next/client/components/redirect.ts +++ b/packages/next/client/components/redirect.ts @@ -1,6 +1,6 @@ export const REDIRECT_ERROR_CODE = 'NEXT_REDIRECT' -export function redirect(url: string) { +export function redirect(url: string): never { // eslint-disable-next-line no-throw-literal const error = new Error(REDIRECT_ERROR_CODE) ;(error as any).digest = REDIRECT_ERROR_CODE + ';' + url