Module: @ts-rest/nest
Classes
Type Aliases
NestControllerContract
Ƭ NestControllerContract<T>: Pick<T, { [K in keyof T]-?: T[K] extends AppRoute ? K : never }[keyof T]>
Type parameters
| Name | Type |
|---|---|
T | extends AppRouter |
Defined in
libs/ts-rest/nest/src/lib/ts-rest-nest.ts:49
NestControllerInterface
Ƭ NestControllerInterface<T>: AppRouterControllerShape<T>
Type parameters
| Name | Type |
|---|---|
T | extends AppRouter |
Defined in
libs/ts-rest/nest/src/lib/ts-rest-nest.ts:55
NestRequestShapes
Ƭ NestRequestShapes<T>: AppRouterRequestShapes<T>
Type parameters
| Name | Type |
|---|---|
T | extends AppRouter |
Defined in
libs/ts-rest/nest/src/lib/ts-rest-nest.ts:57
NestResponseShapes
Ƭ NestResponseShapes<T>: AppRouterResponseShapes<T>
Type parameters
| Name | Type |
|---|---|
T | extends AppRouter |
Defined in
libs/ts-rest/nest/src/lib/ts-rest-nest.ts:58
TsRestOptions
Ƭ TsRestOptions: Object
Type declaration
| Name | Type |
|---|---|
jsonQuery? | boolean |
validateResponses? | boolean |
Defined in
libs/ts-rest/nest/src/lib/ts-rest.decorator.ts:19
TsRestRequestShape
Ƭ TsRestRequestShape<TRoute>: Without<{ body: TRoute extends AppRouteMutation ? BodyWithoutFileIfMultiPart<TRoute> : never ; params: PathParamsWithCustomValidators<TRoute> ; query: ZodInferOrType<TRoute["query"]> }, never>
Type parameters
| Name | Type |
|---|---|
TRoute | extends AppRoute |
Defined in
libs/ts-rest/nest/src/lib/ts-rest-request.decorator.ts:24
Variables
JsonQuerySymbol
• Const JsonQuerySymbol: typeof JsonQuerySymbol
Defined in
libs/ts-rest/nest/src/lib/constants.ts:2
TsRestAppRouteMetadataKey
• Const TsRestAppRouteMetadataKey: typeof TsRestAppRouteMetadataKey
Defined in
libs/ts-rest/nest/src/lib/constants.ts:1
ValidateResponsesSymbol
• Const ValidateResponsesSymbol: typeof ValidateResponsesSymbol
Defined in
libs/ts-rest/nest/src/lib/constants.ts:3
Functions
Api
▸ Api(appRoute): MethodDecorator
Deprecated
Use TsRest decorator instead
Parameters
| Name | Type |
|---|---|
appRoute | AppRoute |
Returns
MethodDecorator
Defined in
libs/ts-rest/nest/src/lib/ts-rest.decorator.ts:84
ApiDecorator
▸ ApiDecorator(...dataOrPipes): ParameterDecorator
Deprecated
Use TsRestRequest instead
Parameters
| Name | Type |
|---|---|
...dataOrPipes | unknown[] |
Returns
ParameterDecorator
Defined in
node_modules/.pnpm/@nestjs+common@9.0.11_j5hagqx4mwzscud4kyjdvubauy/node_modules/@nestjs/common/decorators/http/create-route-param-metadata.decorator.d.ts:10
JsonQuery
▸ JsonQuery(jsonQuery?): CustomDecorator<typeof JsonQuerySymbol>
Enable JSON query mode for a controller or a single route
Parameters
| Name | Type | Default value |
|---|---|---|
jsonQuery | boolean | true |
Returns
CustomDecorator<typeof JsonQuerySymbol>
Defined in
libs/ts-rest/nest/src/lib/json-query.decorator.ts:7
TsRest
▸ TsRest(appRoute, options?): MethodDecorator
As a class decorator, you can configure ts-rest options. As a method decorator, you can assign the route and also configure options
Parameters
| Name | Type | Description |
|---|---|---|
appRoute | AppRoute | - |
options? | TsRestOptions | For a method decorator, this is the options |
Returns
MethodDecorator
Defined in
libs/ts-rest/nest/src/lib/ts-rest.decorator.ts:25
▸ TsRest(options): ClassDecorator
As a class decorator, you can configure ts-rest options. As a method decorator, you can assign the route and also configure options
Parameters
| Name | Type | Description |
|---|---|---|
options | TsRestOptions | For a method decorator, this is the options |
Returns
ClassDecorator
Defined in
libs/ts-rest/nest/src/lib/ts-rest.decorator.ts:26
TsRestRequest
▸ TsRestRequest(...dataOrPipes): ParameterDecorator
Parameter decorator used to parse, validate and return the typed request object
Parameters
| Name | Type |
|---|---|
...dataOrPipes | unknown[] |
Returns
ParameterDecorator
Defined in
node_modules/.pnpm/@nestjs+common@9.0.11_j5hagqx4mwzscud4kyjdvubauy/node_modules/@nestjs/common/decorators/http/create-route-param-metadata.decorator.d.ts:10
initNestServer
▸ initNestServer<T>(router): Object
Deprecated
Use nestControllerContract, NestControllerInterface, NestRequestShapes, and NestResponseShapes instead
See
docs for more info.
Type parameters
| Name | Type |
|---|---|
T | extends AppRouter |
Parameters
| Name | Type |
|---|---|
router | T |
Returns
Object
| Name | Type |
|---|---|
controllerShape | AppRouterControllerShape<T> |
responseShapes | AppRouterResponseShapes<T> |
route | T |
routeShapes | AppRouterRequestShapes<T> |
Defined in
libs/ts-rest/nest/src/lib/ts-rest-nest.ts:40
nestControllerContract
▸ nestControllerContract<T>(router): NestControllerContract<T>
Returns the contract containing only non-nested routes required by a NestJS controller
Type parameters
| Name | Type |
|---|---|
T | extends AppRouter |
Parameters
| Name | Type |
|---|---|
router | T |
Returns
Defined in
libs/ts-rest/nest/src/lib/ts-rest-nest.ts:64