38 lines
1.4 KiB
TypeScript
38 lines
1.4 KiB
TypeScript
import { PipeTransform } from '../interfaces/features/pipe-transform.interface';
|
|
import { ErrorHttpStatusCode } from '../utils/http-error-by-code.util';
|
|
export interface ParseDatePipeOptions {
|
|
/**
|
|
* If true, the pipe will return null or undefined if the value is not provided
|
|
* @default false
|
|
*/
|
|
optional?: boolean;
|
|
/**
|
|
* Default value for the date
|
|
*/
|
|
default?: () => Date;
|
|
/**
|
|
* The HTTP status code to be used in the response when the validation fails.
|
|
*/
|
|
errorHttpStatusCode?: ErrorHttpStatusCode;
|
|
/**
|
|
* A factory function that returns an exception object to be thrown
|
|
* if validation fails.
|
|
* @param error Error message
|
|
* @returns The exception object
|
|
*/
|
|
exceptionFactory?: (error: string) => any;
|
|
}
|
|
export declare class ParseDatePipe implements PipeTransform<string | number | undefined | null> {
|
|
private readonly options;
|
|
protected exceptionFactory: (error: string) => any;
|
|
constructor(options?: ParseDatePipeOptions);
|
|
/**
|
|
* Method that accesses and performs optional transformation on argument for
|
|
* in-flight requests.
|
|
*
|
|
* @param value currently processed route argument
|
|
* @param metadata contains metadata about the currently processed route argument
|
|
*/
|
|
transform(value: string | number | undefined | null): Date | null | undefined;
|
|
}
|