ApplicationConfig

  
class ApplicationConfig {
  constructor(ioAdapter: any = null)
  setGlobalPrefix(prefix: string)
  getGlobalPrefix()
  setGlobalPrefixOptions(options: GlobalPrefixOptions<ExcludeRouteMetadata>)
  getGlobalPrefixOptions(): GlobalPrefixOptions<ExcludeRouteMetadata>
  setIoAdapter(ioAdapter: WebSocketAdapter)
  getIoAdapter(): WebSocketAdapter
  addGlobalPipe(pipe: PipeTransform<any>)
  useGlobalPipes(...pipes: PipeTransform<any>[])
  getGlobalFilters(): ExceptionFilter[]
  addGlobalFilter(filter: ExceptionFilter)
  useGlobalFilters(...filters: ExceptionFilter[])
  getGlobalPipes(): PipeTransform<any>[]
  getGlobalInterceptors(): NestInterceptor[]
  addGlobalInterceptor(interceptor: NestInterceptor)
  useGlobalInterceptors(...interceptors: NestInterceptor[])
  getGlobalGuards(): CanActivate[]
  addGlobalGuard(guard: CanActivate)
  useGlobalGuards(...guards: CanActivate[])
  addGlobalRequestInterceptor(wrapper: InstanceWrapper<NestInterceptor>)
  getGlobalRequestInterceptors(): InstanceWrapper<NestInterceptor>[]
  addGlobalRequestPipe(wrapper: InstanceWrapper<PipeTransform>)
  getGlobalRequestPipes(): InstanceWrapper<PipeTransform>[]
  addGlobalRequestFilter(wrapper: InstanceWrapper<ExceptionFilter>)
  getGlobalRequestFilters(): InstanceWrapper<ExceptionFilter>[]
  addGlobalRequestGuard(wrapper: InstanceWrapper<CanActivate>)
  getGlobalRequestGuards(): InstanceWrapper<CanActivate>[]
  enableVersioning(options: VersioningOptions): void
  getVersioning(): VersioningOptions | undefined
}

Constructor


constructor(ioAdapter: any = null)

Parameters

Option Type Description
ioAdapter any

Optional. Default is null.

Methods

setGlobalPrefix()


setGlobalPrefix(prefix: string)

Parameters

Option Type Description
prefix string

getGlobalPrefix()


getGlobalPrefix()

Parameters

There are no parameters.

setGlobalPrefixOptions()


setGlobalPrefixOptions(options: GlobalPrefixOptions<ExcludeRouteMetadata>)

Parameters

Option Type Description
options GlobalPrefixOptions

getGlobalPrefixOptions()


getGlobalPrefixOptions(): GlobalPrefixOptions<ExcludeRouteMetadata>

Parameters

There are no parameters.

Returns

GlobalPrefixOptions<ExcludeRouteMetadata>

setIoAdapter()


setIoAdapter(ioAdapter: WebSocketAdapter)

Parameters

Option Type Description
ioAdapter WebSocketAdapter

getIoAdapter()


getIoAdapter(): WebSocketAdapter

Parameters

There are no parameters.

Returns

WebSocketAdapter

addGlobalPipe()


addGlobalPipe(pipe: PipeTransform<any>)

Parameters

Option Type Description
pipe PipeTransform

useGlobalPipes()


useGlobalPipes(...pipes: PipeTransform<any>[])

Parameters

Option Type Description
pipes PipeTransform[]

getGlobalFilters()


getGlobalFilters(): ExceptionFilter[]

Parameters

There are no parameters.

Returns

ExceptionFilter[]

addGlobalFilter()


addGlobalFilter(filter: ExceptionFilter)

Parameters

Option Type Description
filter ExceptionFilter

useGlobalFilters()


useGlobalFilters(...filters: ExceptionFilter[])

Parameters

Option Type Description
filters ExceptionFilter[]

getGlobalPipes()


getGlobalPipes(): PipeTransform<any>[]

Parameters

There are no parameters.

Returns

PipeTransform<any>[]

getGlobalInterceptors()


getGlobalInterceptors(): NestInterceptor[]

Parameters

There are no parameters.

Returns

NestInterceptor[]

addGlobalInterceptor()


addGlobalInterceptor(interceptor: NestInterceptor)

Parameters

Option Type Description
interceptor NestInterceptor

useGlobalInterceptors()


useGlobalInterceptors(...interceptors: NestInterceptor[])

Parameters

Option Type Description
interceptors NestInterceptor[]

getGlobalGuards()


getGlobalGuards(): CanActivate[]

Parameters

There are no parameters.

Returns

CanActivate[]

addGlobalGuard()


addGlobalGuard(guard: CanActivate)

Parameters

Option Type Description
guard CanActivate

useGlobalGuards()


useGlobalGuards(...guards: CanActivate[])

Parameters

Option Type Description
guards CanActivate[]

addGlobalRequestInterceptor()


addGlobalRequestInterceptor(wrapper: InstanceWrapper<NestInterceptor>)

Parameters

Option Type Description
wrapper InstanceWrapper

getGlobalRequestInterceptors()


getGlobalRequestInterceptors(): InstanceWrapper<NestInterceptor>[]

Parameters

There are no parameters.

Returns

InstanceWrapper<NestInterceptor>[]

addGlobalRequestPipe()


addGlobalRequestPipe(wrapper: InstanceWrapper<PipeTransform>)

Parameters

Option Type Description
wrapper InstanceWrapper

getGlobalRequestPipes()


getGlobalRequestPipes(): InstanceWrapper<PipeTransform>[]

Parameters

There are no parameters.

Returns

InstanceWrapper<PipeTransform>[]

addGlobalRequestFilter()


addGlobalRequestFilter(wrapper: InstanceWrapper<ExceptionFilter>)

Parameters

Option Type Description
wrapper InstanceWrapper

getGlobalRequestFilters()


getGlobalRequestFilters(): InstanceWrapper<ExceptionFilter>[]

Parameters

There are no parameters.

Returns

InstanceWrapper<ExceptionFilter>[]

addGlobalRequestGuard()


addGlobalRequestGuard(wrapper: InstanceWrapper<CanActivate>)

Parameters

Option Type Description
wrapper InstanceWrapper

getGlobalRequestGuards()


getGlobalRequestGuards(): InstanceWrapper<CanActivate>[]

Parameters

There are no parameters.

Returns

InstanceWrapper<CanActivate>[]

enableVersioning()


enableVersioning(options: VersioningOptions): void

Parameters

Option Type Description
options VersioningOptions

Returns

void

getVersioning()


getVersioning(): VersioningOptions | undefined

Parameters

There are no parameters.

Returns

VersioningOptions | undefined