36 lines
2.3 KiB
TypeScript
Executable File
36 lines
2.3 KiB
TypeScript
Executable File
import { type WorkStore } from '../app-render/work-async-storage.external';
|
|
export type ParamValue = string | Array<string> | undefined;
|
|
export type Params = Record<string, ParamValue>;
|
|
/**
|
|
* In this version of Next.js the `params` prop passed to Layouts, Pages, and other Segments is a Promise.
|
|
* However to facilitate migration to this new Promise type you can currently still access params directly on the Promise instance passed to these Segments.
|
|
* The `UnsafeUnwrappedParams` type is available if you need to temporarily access the underlying params without first awaiting or `use`ing the Promise.
|
|
*
|
|
* In a future version of Next.js the `params` prop will be a plain Promise and this type will be removed.
|
|
*
|
|
* Typically instances of `params` can be updated automatically to be treated as a Promise by a codemod published alongside this Next.js version however if you
|
|
* have not yet run the codemod of the codemod cannot detect certain instances of `params` usage you should first try to refactor your code to await `params`.
|
|
*
|
|
* If refactoring is not possible but you still want to be able to access params directly without typescript errors you can cast the params Promise to this type
|
|
*
|
|
* ```tsx
|
|
* type Props = { params: Promise<{ id: string }>}
|
|
*
|
|
* export default async function Layout(props: Props) {
|
|
* const directParams = (props.params as unknown as UnsafeUnwrappedParams<typeof props.params>)
|
|
* return ...
|
|
* }
|
|
* ```
|
|
*
|
|
* This type is marked deprecated to help identify it as target for refactoring away.
|
|
*
|
|
* @deprecated
|
|
*/
|
|
export type UnsafeUnwrappedParams<P> = P extends Promise<infer U> ? Omit<U, 'then' | 'status' | 'value'> : never;
|
|
export declare function createParamsFromClient(underlyingParams: Params, workStore: WorkStore): Promise<Params>;
|
|
export type CreateServerParamsForMetadata = typeof createServerParamsForMetadata;
|
|
export declare const createServerParamsForMetadata: typeof createServerParamsForServerSegment;
|
|
export declare function createServerParamsForRoute(underlyingParams: Params, workStore: WorkStore): Promise<Params>;
|
|
export declare function createServerParamsForServerSegment(underlyingParams: Params, workStore: WorkStore): Promise<Params>;
|
|
export declare function createPrerenderParamsForClientSegment(underlyingParams: Params): Promise<Params>;
|