Class ParseBoolPipe

Defines the built-in ParseBool Pipe

see: Built-in Pipes
publicapi

Hierarchy

ParseBoolPipe

Implements

PipeTransform<string | boolean, Promise<boolean>>

Index

Constructors

constructor

Properties

exceptionFactory

Methods

transform

Constructors

constructor

new ParseBoolPipe(options?: ParseBoolPipeOptions): ParseBoolPipe

- Defined in packages/common/pipes/parse-bool.pipe.ts:23
Parameters
- Optional options: ParseBoolPipeOptions
Returns ParseBoolPipe

Properties

Protected exceptionFactory

exceptionFactory: (error: string) => any

Type declaration

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

Methods

transform

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

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

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

Generated using TypeDoc