Class ParseIntPipe

Defines the built-in ParseInt Pipe

see: Built-in Pipes
publicapi

Hierarchy

ParseIntPipe

Implements

PipeTransform<string>

Index

Constructors

constructor

Properties

exceptionFactory

Methods

transform

Constructors

constructor

new ParseIntPipe(options?: ParseIntPipeOptions): ParseIntPipe

- Defined in packages/common/pipes/parse-int.pipe.ts:22
Parameters
- Optional options: ParseIntPipeOptions
Returns ParseIntPipe

Properties

Protected exceptionFactory

exceptionFactory: (error: string) => any

Type declaration

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

Methods

transform

transform(value: string, metadata: ArgumentMetadata): Promise<number>

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

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

Generated using TypeDoc