Initial boiler plate project
This commit is contained in:
118
node_modules/next/dist/server/future/route-modules/app-route/module.d.ts
generated
vendored
Normal file
118
node_modules/next/dist/server/future/route-modules/app-route/module.d.ts
generated
vendored
Normal file
@ -0,0 +1,118 @@
|
||||
import type { NextConfig } from '../../../config-shared';
|
||||
import type { AppRouteRouteDefinition } from '../../route-definitions/app-route-route-definition';
|
||||
import type { AppConfig } from '../../../../build/utils';
|
||||
import type { NextRequest } from '../../../web/spec-extension/request';
|
||||
import type { PrerenderManifest } from '../../../../build';
|
||||
import type { DeepReadonly } from '../../../../shared/lib/deep-readonly';
|
||||
import { RouteModule, type RouteModuleHandleContext, type RouteModuleOptions } from '../route-module';
|
||||
import { type StaticGenerationContext } from '../../../async-storage/static-generation-async-storage-wrapper';
|
||||
import { type HTTP_METHOD } from '../../../web/http';
|
||||
import * as serverHooks from '../../../../client/components/hooks-server-context';
|
||||
import * as sharedModules from './shared-modules';
|
||||
/**
|
||||
* The AppRouteModule is the type of the module exported by the bundled App
|
||||
* Route module.
|
||||
*/
|
||||
export type AppRouteModule = typeof import('../../../../build/templates/app-route');
|
||||
/**
|
||||
* AppRouteRouteHandlerContext is the context that is passed to the route
|
||||
* handler for app routes.
|
||||
*/
|
||||
export interface AppRouteRouteHandlerContext extends RouteModuleHandleContext {
|
||||
renderOpts: StaticGenerationContext['renderOpts'];
|
||||
prerenderManifest: DeepReadonly<PrerenderManifest>;
|
||||
}
|
||||
/**
|
||||
* AppRouteHandlerFnContext is the context that is passed to the handler as the
|
||||
* second argument.
|
||||
*/
|
||||
type AppRouteHandlerFnContext = {
|
||||
params?: Record<string, string | string[]>;
|
||||
};
|
||||
/**
|
||||
* Handler function for app routes. If a non-Response value is returned, an error
|
||||
* will be thrown.
|
||||
*/
|
||||
export type AppRouteHandlerFn = (
|
||||
/**
|
||||
* Incoming request object.
|
||||
*/
|
||||
req: NextRequest,
|
||||
/**
|
||||
* Context properties on the request (including the parameters if this was a
|
||||
* dynamic route).
|
||||
*/
|
||||
ctx: AppRouteHandlerFnContext) => unknown;
|
||||
/**
|
||||
* AppRouteHandlers describes the handlers for app routes that is provided by
|
||||
* the userland module.
|
||||
*/
|
||||
export type AppRouteHandlers = {
|
||||
[method in HTTP_METHOD]?: AppRouteHandlerFn;
|
||||
};
|
||||
/**
|
||||
* AppRouteUserlandModule is the userland module that is provided for app
|
||||
* routes. This contains all the user generated code.
|
||||
*/
|
||||
export type AppRouteUserlandModule = AppRouteHandlers & Pick<AppConfig, 'dynamic' | 'revalidate' | 'dynamicParams' | 'fetchCache'> & {
|
||||
generateStaticParams?: any;
|
||||
};
|
||||
/**
|
||||
* AppRouteRouteModuleOptions is the options that are passed to the app route
|
||||
* module from the bundled code.
|
||||
*/
|
||||
export interface AppRouteRouteModuleOptions extends RouteModuleOptions<AppRouteRouteDefinition, AppRouteUserlandModule> {
|
||||
readonly resolvedPagePath: string;
|
||||
readonly nextConfigOutput: NextConfig['output'];
|
||||
}
|
||||
/**
|
||||
* AppRouteRouteHandler is the handler for app routes.
|
||||
*/
|
||||
export declare class AppRouteRouteModule extends RouteModule<AppRouteRouteDefinition, AppRouteUserlandModule> {
|
||||
/**
|
||||
* A reference to the request async storage.
|
||||
*/
|
||||
readonly requestAsyncStorage: import("../../../../client/components/request-async-storage.external").RequestAsyncStorage;
|
||||
/**
|
||||
* A reference to the static generation async storage.
|
||||
*/
|
||||
readonly staticGenerationAsyncStorage: import("../../../../client/components/static-generation-async-storage.external").StaticGenerationAsyncStorage;
|
||||
/**
|
||||
* An interface to call server hooks which interact with the underlying
|
||||
* storage.
|
||||
*/
|
||||
readonly serverHooks: typeof serverHooks;
|
||||
static readonly sharedModules: typeof sharedModules;
|
||||
/**
|
||||
* A reference to the mutation related async storage, such as mutations of
|
||||
* cookies.
|
||||
*/
|
||||
readonly actionAsyncStorage: import("../../../../client/components/action-async-storage.external").ActionAsyncStorage;
|
||||
readonly resolvedPagePath: string;
|
||||
readonly nextConfigOutput: NextConfig['output'] | undefined;
|
||||
private readonly methods;
|
||||
private readonly hasNonStaticMethods;
|
||||
private readonly dynamic;
|
||||
constructor({ userland, definition, resolvedPagePath, nextConfigOutput, }: AppRouteRouteModuleOptions);
|
||||
/**
|
||||
* Resolves the handler function for the given method.
|
||||
*
|
||||
* @param method the requested method
|
||||
* @returns the handler function for the given method
|
||||
*/
|
||||
private resolve;
|
||||
/**
|
||||
* Executes the route handler.
|
||||
*/
|
||||
private execute;
|
||||
handle(request: NextRequest, context: AppRouteRouteHandlerContext): Promise<Response>;
|
||||
}
|
||||
export default AppRouteRouteModule;
|
||||
/**
|
||||
* Gets all the method names for handlers that are not considered static.
|
||||
*
|
||||
* @param handlers the handlers from the userland module
|
||||
* @returns the method names that are not considered static or false if all
|
||||
* methods are static
|
||||
*/
|
||||
export declare function hasNonStaticMethods(handlers: AppRouteHandlers): boolean;
|
||||
Reference in New Issue
Block a user