Class ParseArrayPipe

Defines the built-in ParseArray Pipe

see: Built-in Pipes
publicapi

Hierarchy

ParseArrayPipe

Implements

PipeTransform

Index

Constructors

constructor

Properties

Methods

transform

Constructors

constructor

new ParseArrayPipe(options?: ParseArrayOptions): ParseArrayPipe

- Defined in packages/common/pipes/parse-array.pipe.ts:32
Parameters
- Default value options: ParseArrayOptions = {}
Returns ParseArrayPipe

Properties

Protected exceptionFactory

exceptionFactory: (error: string) => any

Type declaration

- (error: string): any
- Parameters
  - error: string
  Returns any

Private Readonly options

options: ParseArrayOptions

Protected Readonly validationPipe

validationPipe: ValidationPipe

Methods

transform

transform(value: any, metadata: ArgumentMetadata): Promise<any>

- Defined in packages/common/pipes/parse-array.pipe.ts:57
Method that accesses and performs optional transformation on argument for in-flight requests.

Parameters
- value: any
  
  currently processed route argument
- metadata: ArgumentMetadata
  
  contains metadata about the currently processed route argument
Returns Promise<any>

Generated using TypeDoc