Module: @ts-rest/next
Functions
createNextRoute
▸ createNextRoute<T
>(appRouter
, implementation
): RecursiveRouterObj
<T
>
Create the implementation for a given AppRouter.
Type parameters
Name | Type |
---|---|
T | extends AppRouter |
Parameters
Name | Type | Description |
---|---|---|
appRouter | T | AppRouter |
implementation | RecursiveRouterObj <T > | Implementation of the AppRouter, e.g. your API controllers |
Returns
RecursiveRouterObj
<T
>
Defined in
libs/ts-rest/next/src/lib/ts-rest-next.ts:178
createNextRouter
▸ createNextRouter<T
>(routes
, obj
, options?
): (req
: NextApiRequest
, res
: NextApiResponse
<any
>) => Promise
<void
>
Turn a completed set of Next routes into a Next.js compatible route.
Should be exported from your [...ts-rest].tsx file.
e.g.
export default createNextRouter(contract, implementation);
Type parameters
Name | Type |
---|---|
T | extends AppRouter |
Parameters
Name | Type |
---|---|
routes | T |
obj | RecursiveRouterObj <T > |
options? | Object |
options.errorHandler? | (err : unknown , req : NextApiRequest , res : NextApiResponse <any >) => void |
options.jsonQuery? | boolean |
options.responseValidation? | boolean |
Returns
fn
▸ (req
, res
): Promise
<void
>
Parameters
Name | Type |
---|---|
req | NextApiRequest |
res | NextApiResponse <any > |
Returns
Promise
<void
>
Defined in
libs/ts-rest/next/src/lib/ts-rest-next.ts:199
isAppRouteWithImplementation
▸ isAppRouteWithImplementation(obj
): obj is any
Parameters
Name | Type |
---|---|
obj | any |
Returns
obj is any
Defined in
libs/ts-rest/next/src/lib/ts-rest-next.ts:99