ClassSerializerInterceptor

  
class ClassSerializerInterceptor implements NestInterceptor {
  protected reflector: any
  protected defaultOptions: ClassSerializerInterceptorOptions
  intercept(context: ExecutionContext, next: CallHandler<any>): Observable<any>
  serialize(response: PlainLiteralObject | PlainLiteralObject[], options: ClassSerializerContextOptions): PlainLiteralObject | Array<PlainLiteralObject>
  transformToPlain(plainOrClass: any, options: ClassSerializerContextOptions): PlainLiteralObject
  protected getContextOptions(context: ExecutionContext): ClassSerializerContextOptions | undefined
}

Properties

Property Description
protected reflector: any Read-only.
protected defaultOptions: ClassSerializerInterceptorOptions Read-only.

Methods

intercept()


intercept(context: ExecutionContext, next: CallHandler<any>): Observable<any>

Parameters

Option Type Description
context ExecutionContext
next CallHandler

Returns

Observable<any>

serialize()

Serializes responses that are non-null objects nor streamable files.


serialize(response: PlainLiteralObject | PlainLiteralObject[], options: ClassSerializerContextOptions): PlainLiteralObject | Array<PlainLiteralObject>

Parameters

Option Type Description
response PlainLiteralObject | PlainLiteralObject[]
options ClassSerializerContextOptions

Returns

PlainLiteralObject | Array<PlainLiteralObject>

transformToPlain()


transformToPlain(plainOrClass: any, options: ClassSerializerContextOptions): PlainLiteralObject

Parameters

Option Type Description
plainOrClass any
options ClassSerializerContextOptions

Returns

PlainLiteralObject

getContextOptions()


protected getContextOptions(context: ExecutionContext): ClassSerializerContextOptions | undefined

Parameters

Option Type Description
context ExecutionContext

Returns

ClassSerializerContextOptions | undefined