Skip to content

Commit

Permalink
chore(adapter-nextjs): update tsdoc of the public APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
HuiSF committed Feb 6, 2025
1 parent 0bb24df commit 641771f
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions packages/adapter-nextjs/src/types/NextServer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,20 @@ export declare namespace NextServer {
}

export interface CreateServerRunnerOutput {
/**
* The function to run an operation with the Amplify server context. The operation is a callback function that
* takes a context spec parameter which is used to call the Amplify-side server APIs. The result of the operation
* is returned as a promise.
*/
runWithAmplifyServerContext: RunOperationWithContext;
/**
* The factory function to create the route handlers for the Amplify server-side authentication. You can call this
* function and export the result as the route handlers in the Next.js API routes, to authenticate your end users
* on the server side.
*
* Note: when enabling server-side authentication, Amplify APIs can no longer be used in the client-side.
* @experimental
*/
createAuthRouteHandlers: CreateAuthRouteHandlers;
}

Expand Down

0 comments on commit 641771f

Please sign in to comment.