Initial boiler plate project
This commit is contained in:
98
node_modules/next/dist/server/future/route-modules/pages-api/module.d.ts
generated
vendored
Normal file
98
node_modules/next/dist/server/future/route-modules/pages-api/module.d.ts
generated
vendored
Normal file
@ -0,0 +1,98 @@
|
||||
/// <reference types="node" />
|
||||
/// <reference types="node" />
|
||||
import type { IncomingMessage, ServerResponse } from 'http';
|
||||
import type { PagesAPIRouteDefinition } from '../../route-definitions/pages-api-route-definition';
|
||||
import type { PageConfig } from '../../../../../types';
|
||||
import type { ParsedUrlQuery } from 'querystring';
|
||||
import { type __ApiPreviewProps } from '../../../api-utils';
|
||||
import type { RouteModuleOptions } from '../route-module';
|
||||
import { RouteModule, type RouteModuleHandleContext } from '../route-module';
|
||||
type PagesAPIHandleFn = (req: IncomingMessage, res: ServerResponse) => Promise<void>;
|
||||
/**
|
||||
* The PagesAPIModule is the type of the module exported by the bundled Pages
|
||||
* API module.
|
||||
*/
|
||||
export type PagesAPIModule = typeof import('../../../../build/templates/pages-api');
|
||||
type PagesAPIUserlandModule = {
|
||||
/**
|
||||
* The exported handler method.
|
||||
*/
|
||||
readonly default: PagesAPIHandleFn;
|
||||
/**
|
||||
* The exported page config.
|
||||
*/
|
||||
readonly config?: PageConfig;
|
||||
};
|
||||
type PagesAPIRouteHandlerContext = RouteModuleHandleContext & {
|
||||
/**
|
||||
* The incoming server request in non-edge runtime.
|
||||
*/
|
||||
req?: IncomingMessage;
|
||||
/**
|
||||
* The outgoing server response in non-edge runtime.
|
||||
*/
|
||||
res?: ServerResponse;
|
||||
/**
|
||||
* The revalidate method used by the `revalidate` API.
|
||||
*
|
||||
* @param config the configuration for the revalidation
|
||||
*/
|
||||
revalidate: (config: {
|
||||
urlPath: string;
|
||||
revalidateHeaders: {
|
||||
[key: string]: string | string[];
|
||||
};
|
||||
opts: {
|
||||
unstable_onlyGenerated?: boolean;
|
||||
};
|
||||
}) => Promise<void>;
|
||||
/**
|
||||
* The hostname for the request.
|
||||
*/
|
||||
hostname?: string;
|
||||
/**
|
||||
* Keys allowed in the revalidate call.
|
||||
*/
|
||||
allowedRevalidateHeaderKeys?: string[];
|
||||
/**
|
||||
* Whether to trust the host header.
|
||||
*/
|
||||
trustHostHeader?: boolean;
|
||||
/**
|
||||
* The query for the request.
|
||||
*/
|
||||
query: ParsedUrlQuery;
|
||||
/**
|
||||
* The preview props used by the `preview` API.
|
||||
*/
|
||||
previewProps: __ApiPreviewProps;
|
||||
/**
|
||||
* True if the server is in development mode.
|
||||
*/
|
||||
dev: boolean;
|
||||
/**
|
||||
* True if the server is in minimal mode.
|
||||
*/
|
||||
minimalMode: boolean;
|
||||
/**
|
||||
* The page that's being rendered.
|
||||
*/
|
||||
page: string;
|
||||
/**
|
||||
* whether multi-zone flag is enabled for draft mode
|
||||
*/
|
||||
multiZoneDraftMode?: boolean;
|
||||
};
|
||||
export type PagesAPIRouteModuleOptions = RouteModuleOptions<PagesAPIRouteDefinition, PagesAPIUserlandModule>;
|
||||
export declare class PagesAPIRouteModule extends RouteModule<PagesAPIRouteDefinition, PagesAPIUserlandModule> {
|
||||
private apiResolverWrapped;
|
||||
constructor(options: PagesAPIRouteModuleOptions);
|
||||
/**
|
||||
*
|
||||
* @param req the incoming server request
|
||||
* @param res the outgoing server response
|
||||
* @param context the context for the render
|
||||
*/
|
||||
render(req: IncomingMessage, res: ServerResponse, context: PagesAPIRouteHandlerContext): Promise<void>;
|
||||
}
|
||||
export default PagesAPIRouteModule;
|
||||
Reference in New Issue
Block a user