Class: TsRestException<T>
@ts-rest/nest.TsRestException
Error you can throw to return a response from a handler
Type parameters
Name | Type |
---|---|
T | extends AppRoute |
Hierarchy
HttpException
↳
TsRestException
Constructors
constructor
• new TsRestException<T
>(route
, response
, options?
)
Type parameters
Name | Type |
---|---|
T | extends AppRoute |
Parameters
Name | Type |
---|---|
route | T |
response | ServerInferResponses <T > |
options? | HttpExceptionOptions |
Overrides
HttpException.constructor
Defined in
libs/ts-rest/nest/src/lib/ts-rest-nest-handler.ts:165
Properties
cause
• cause: unknown
Inherited from
HttpException.cause
Defined in
node_modules/.pnpm/@nestjs+common@10.3.10_reflect-metadata@0.1.13_rxjs@7.8.1/node_modules/@nestjs/common/exceptions/http.exception.d.ts:57
message
• message: string
Inherited from
HttpException.message
Defined in
node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1068
name
• name: string
Inherited from
HttpException.name
Defined in
node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1067
stack
• Optional
stack: string
Inherited from
HttpException.stack
Defined in
node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1069
prepareStackTrace
▪ Static
Optional
prepareStackTrace: (err
: Error
, stackTraces
: CallSite
[]) => any
Type declaration
▸ (err
, stackTraces
): any
Optional override for formatting stack traces
Parameters
Name | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
HttpException.prepareStackTrace
Defined in
node_modules/.pnpm/@types+node@20.16.1/node_modules/@types/node/globals.d.ts:28
stackTraceLimit
▪ Static
stackTraceLimit: number
Inherited from
HttpException.stackTraceLimit
Defined in
node_modules/.pnpm/@types+node@20.16.1/node_modules/@types/node/globals.d.ts:30
Methods
getResponse
▸ getResponse(): string
| object
Returns
string
| object
Inherited from
HttpException.getResponse
Defined in
node_modules/.pnpm/@nestjs+common@10.3.10_reflect-metadata@0.1.13_rxjs@7.8.1/node_modules/@nestjs/common/exceptions/http.exception.d.ts:67
getStatus
▸ getStatus(): number
Returns
number
Inherited from
HttpException.getStatus
Defined in
node_modules/.pnpm/@nestjs+common@10.3.10_reflect-metadata@0.1.13_rxjs@7.8.1/node_modules/@nestjs/common/exceptions/http.exception.d.ts:68
initCause
▸ initCause(): void
Configures error chaining support
Returns
void
See
- https://nodejs.org/en/blog/release/v16.9.0/#error-cause
- https://github.com/microsoft/TypeScript/issues/45167
Inherited from
HttpException.initCause
Defined in
node_modules/.pnpm/@nestjs+common@10.3.10_reflect-metadata@0.1.13_rxjs@7.8.1/node_modules/@nestjs/common/exceptions/http.exception.d.ts:64
initMessage
▸ initMessage(): void
Returns
void
Inherited from
HttpException.initMessage
Defined in
node_modules/.pnpm/@nestjs+common@10.3.10_reflect-metadata@0.1.13_rxjs@7.8.1/node_modules/@nestjs/common/exceptions/http.exception.d.ts:65
initName
▸ initName(): void
Returns
void
Inherited from
HttpException.initName
Defined in
node_modules/.pnpm/@nestjs+common@10.3.10_reflect-metadata@0.1.13_rxjs@7.8.1/node_modules/@nestjs/common/exceptions/http.exception.d.ts:66
captureStackTrace
▸ Static
captureStackTrace(targetObject
, constructorOpt?
): void
Create .stack property on a target object
Parameters
Name | Type |
---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
HttpException.captureStackTrace
Defined in
node_modules/.pnpm/@types+node@20.16.1/node_modules/@types/node/globals.d.ts:21
createBody
▸ Static
createBody(nil
, message
, statusCode
): HttpExceptionBody
Parameters
Name | Type |
---|---|
nil | null | "" |
message | HttpExceptionBodyMessage |
statusCode | number |
Returns
HttpExceptionBody
Inherited from
HttpException.createBody
Defined in
node_modules/.pnpm/@nestjs+common@10.3.10_reflect-metadata@0.1.13_rxjs@7.8.1/node_modules/@nestjs/common/exceptions/http.exception.d.ts:69
▸ Static
createBody(message
, error
, statusCode
): HttpExceptionBody
Parameters
Name | Type |
---|---|
message | HttpExceptionBodyMessage |
error | string |
statusCode | number |
Returns
HttpExceptionBody
Inherited from
HttpException.createBody
Defined in
node_modules/.pnpm/@nestjs+common@10.3.10_reflect-metadata@0.1.13_rxjs@7.8.1/node_modules/@nestjs/common/exceptions/http.exception.d.ts:70
▸ Static
createBody<Body
>(custom
): Body
Type parameters
Name | Type |
---|---|
Body | extends Record <string , unknown > |
Parameters
Name | Type |
---|---|
custom | Body |
Returns
Body
Inherited from
HttpException.createBody
Defined in
node_modules/.pnpm/@nestjs+common@10.3.10_reflect-metadata@0.1.13_rxjs@7.8.1/node_modules/@nestjs/common/exceptions/http.exception.d.ts:71
extractDescriptionAndOptionsFrom
▸ Static
extractDescriptionAndOptionsFrom(descriptionOrOptions
): DescriptionAndOptions
Utility method used to extract the error description and httpExceptionOptions from the given argument. This is used by inheriting classes to correctly parse both options.
Parameters
Name | Type |
---|---|
descriptionOrOptions | string | HttpExceptionOptions |
Returns
DescriptionAndOptions
the error description and the httpExceptionOptions as an object.
Inherited from
HttpException.extractDescriptionAndOptionsFrom
Defined in
node_modules/.pnpm/@nestjs+common@10.3.10_reflect-metadata@0.1.13_rxjs@7.8.1/node_modules/@nestjs/common/exceptions/http.exception.d.ts:79
getDescriptionFrom
▸ Static
getDescriptionFrom(descriptionOrOptions
): string
Parameters
Name | Type |
---|---|
descriptionOrOptions | string | HttpExceptionOptions |
Returns
string
Inherited from
HttpException.getDescriptionFrom
Defined in
node_modules/.pnpm/@nestjs+common@10.3.10_reflect-metadata@0.1.13_rxjs@7.8.1/node_modules/@nestjs/common/exceptions/http.exception.d.ts:72
getHttpExceptionOptionsFrom
▸ Static
getHttpExceptionOptionsFrom(descriptionOrOptions
): HttpExceptionOptions
Parameters
Name | Type |
---|---|
descriptionOrOptions | string | HttpExceptionOptions |
Returns
HttpExceptionOptions
Inherited from
HttpException.getHttpExceptionOptionsFrom
Defined in
node_modules/.pnpm/@nestjs+common@10.3.10_reflect-metadata@0.1.13_rxjs@7.8.1/node_modules/@nestjs/common/exceptions/http.exception.d.ts:73