nestjs-clone-bay docs
GitHub
GitHub
  • Introduction
  • Testing
  • API Reference

Class: InvalidConfigurationException

Hierarchy

  • CloneBayException

    ↳ InvalidConfigurationException

Constructors

constructor

• new InvalidConfigurationException(): InvalidConfigurationException

Returns

InvalidConfigurationException

Overrides

CloneBayException.constructor

Defined in

lib/src/exceptions/invalid-configuration.exception.ts:8

Methods

getResponse

▸ getResponse(): string | object

Returns

string | object

Inherited from

CloneBayException.getResponse

Defined in

lib/node_modules/@nestjs/common/exceptions/http.exception.d.ts:72


getStatus

▸ getStatus(): number

Returns

number

Inherited from

CloneBayException.getStatus

Defined in

lib/node_modules/@nestjs/common/exceptions/http.exception.d.ts:73


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

CloneBayException.initCause

Defined in

lib/node_modules/@nestjs/common/exceptions/http.exception.d.ts:69


initMessage

▸ initMessage(): void

Returns

void

Inherited from

CloneBayException.initMessage

Defined in

lib/node_modules/@nestjs/common/exceptions/http.exception.d.ts:70


initName

▸ initName(): void

Returns

void

Inherited from

CloneBayException.initName

Defined in

lib/node_modules/@nestjs/common/exceptions/http.exception.d.ts:71


captureStackTrace

▸ captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

CloneBayException.captureStackTrace

Defined in

lib/node_modules/@types/node/globals.d.ts:136


createBody

▸ createBody(nil, message, statusCode): HttpExceptionBody

Parameters

NameType
nilnull | ""
messageHttpExceptionBodyMessage
statusCodenumber

Returns

HttpExceptionBody

Inherited from

CloneBayException.createBody

Defined in

lib/node_modules/@nestjs/common/exceptions/http.exception.d.ts:74

▸ createBody(message, error, statusCode): HttpExceptionBody

Parameters

NameType
messageHttpExceptionBodyMessage
errorstring
statusCodenumber

Returns

HttpExceptionBody

Inherited from

CloneBayException.createBody

Defined in

lib/node_modules/@nestjs/common/exceptions/http.exception.d.ts:75

▸ createBody<Body>(custom): Body

Type parameters

NameType
Bodyextends Record<string, unknown>

Parameters

NameType
customBody

Returns

Body

Inherited from

CloneBayException.createBody

Defined in

lib/node_modules/@nestjs/common/exceptions/http.exception.d.ts:76


extractDescriptionAndOptionsFrom

▸ 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

NameType
descriptionOrOptionsstring | HttpExceptionOptions

Returns

DescriptionAndOptions

the error description and the httpExceptionOptions as an object.

Inherited from

CloneBayException.extractDescriptionAndOptionsFrom

Defined in

lib/node_modules/@nestjs/common/exceptions/http.exception.d.ts:84


getDescriptionFrom

▸ getDescriptionFrom(descriptionOrOptions): string

Parameters

NameType
descriptionOrOptionsstring | HttpExceptionOptions

Returns

string

Inherited from

CloneBayException.getDescriptionFrom

Defined in

lib/node_modules/@nestjs/common/exceptions/http.exception.d.ts:77


getHttpExceptionOptionsFrom

▸ getHttpExceptionOptionsFrom(descriptionOrOptions): HttpExceptionOptions

Parameters

NameType
descriptionOrOptionsstring | HttpExceptionOptions

Returns

HttpExceptionOptions

Inherited from

CloneBayException.getHttpExceptionOptionsFrom

Defined in

lib/node_modules/@nestjs/common/exceptions/http.exception.d.ts:78

Properties

cause

• cause: unknown

Exception cause. Indicates the specific original cause of the error. It is used when catching and re-throwing an error with a more-specific or useful error message in order to still have access to the original error.

Inherited from

CloneBayException.cause

Defined in

lib/node_modules/@nestjs/common/exceptions/http.exception.d.ts:28


message

• message: string

Inherited from

CloneBayException.message

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1077


name

• name: string

Inherited from

CloneBayException.name

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1076


stack

• Optional stack: string

Inherited from

CloneBayException.stack

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1078


prepareStackTrace

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

CloneBayException.prepareStackTrace

Defined in

lib/node_modules/@types/node/globals.d.ts:143


stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

CloneBayException.stackTraceLimit

Defined in

lib/node_modules/@types/node/globals.d.ts:145

Edit this page
Last Updated: