@nestjs/common
Version:
Nest - modern, fast, powerful node.js web framework (@common)
27 lines (26 loc) • 1.12 kB
TypeScript
import { PipeTransform } from '../../interfaces/features/pipe-transform.interface';
import { FileValidator } from './file-validator.interface';
import { ParseFileOptions } from './parse-file-options.interface';
/**
* Defines the built-in ParseFile Pipe. This pipe can be used to validate incoming files
* with `@UploadedFile()` decorator. You can use either other specific built-in validators
* or provide one of your own, simply implementing it through {@link FileValidator}
* interface and adding it to ParseFilePipe's constructor.
*
* @see [Built-in Pipes](https://docs.nestjs.com/pipes#built-in-pipes)
*
* @publicApi
*/
export declare class ParseFilePipe implements PipeTransform<any> {
protected exceptionFactory: (error: string) => any;
private readonly validators;
private readonly fileIsRequired;
constructor(options?: ParseFileOptions);
transform(value: any): Promise<any>;
protected validate(file: any): Promise<any>;
private validateOrThrow;
/**
* @returns list of validators used in this pipe.
*/
getValidators(): FileValidator<Record<string, any>>[];
}