Defines the built-in ParseEnum Pipe
class ParseEnumPipe<T = any> implements PipeTransform {
protected exceptionFactory: (error: string) => any
protected enumType: T
protected options?: ParseEnumPipeOptions
transform(value: T, metadata: ArgumentMetadata): Promise<T>
protected isEnum(value: T): boolean
}
Properties
| Property |
Description |
protected exceptionFactory: (error: string) => any
|
|
protected enumType: T
|
Read-only.
|
protected options?: ParseEnumPipeOptions
|
Read-only.
|
Methods
|
|
|---|
|
Method that accesses and performs optional transformation on argument for
in-flight requests.
|
transform(value: T, metadata: ArgumentMetadata): Promise<T>
Parameters
| Option |
Type |
Description |
value
|
T |
currently processed route argument
|
metadata
|
ArgumentMetadata |
contains metadata about the currently processed route argument
|
Returns
Promise<T>
|
isEnum()
|
|---|
protected isEnum(value: T): boolean
Parameters
| Option |
Type |
Description |
value
|
T |
|
Returns
boolean
|
