ParseArrayPipe

Defines the built-in ParseArray Pipe

  
class ParseArrayPipe implements PipeTransform {
  protected validationPipe: ValidationPipe
  protected exceptionFactory: (error: string) => any
  protected options: ParseArrayOptions
  transform(value: any, metadata: ArgumentMetadata): Promise<any>
  protected isExpectedTypePrimitive(): boolean
  protected validatePrimitive(originalValue: any, index?: number)
}

See also

Properties

Property Description
protected validationPipe: ValidationPipe Read-only.
protected exceptionFactory: (error: string) => any
protected options: ParseArrayOptions Read-only.

Methods

transform()

Method that accesses and performs optional transformation on argument for in-flight requests.


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

Parameters

Option Type Description
value any

currently processed route argument

metadata ArgumentMetadata

contains metadata about the currently processed route argument

Returns

Promise<any>

isExpectedTypePrimitive()


protected isExpectedTypePrimitive(): boolean

Parameters

There are no parameters.

Returns

boolean

validatePrimitive()


protected validatePrimitive(originalValue: any, index?: number)

Parameters

Option Type Description
originalValue any
index number

Optional. Default is undefined.