Interface IControllerRouteWithBodyAndJoiSchemaOptions

Options for a controller route with a body, which validates with a Joi schema.

interface IControllerRouteWithBodyAndJoiSchemaOptions {
    authorize?: Nilable<AuthorizeArgumentValue>;
    deprecated?: Nilable<ControllerRouteDeprecatedValue>;
    documentation?: Nilable<{
        callbacks?: {
            [callback: string]: ReferenceObject | CallbackObject;
        };
        deprecated?: boolean;
        description?: string;
        externalDocs?: ExternalDocumentationObject;
        operationId?: string;
        parameters?: (ReferenceObject | ParameterObject)[];
        requestBody?: ReferenceObject | RequestBodyObject;
        responses: ResponsesObject;
        security?: SecurityRequirementObject[];
        servers?: ServerObject[];
        summary?: string;
        tags?: string[];
    }>;
    format?: Nilable<HttpInputDataFormat>;
    limit?: Nilable<number>;
    noAutoEnd?: Nilable<boolean>;
    noQueryParams?: Nilable<boolean>;
    onError?: Nilable<HttpErrorHandler>;
    onParsingFailed?: Nilable<ParseErrorHandler>;
    onValidationFailed?: Nilable<ValidationFailedHandler>;
    onValidationWithDocumentationFailed?: Nilable<JsonSchemaValidationFailedHandler>;
    parameterFormat?: Nilable<ControllerParameterFormat>;
    path?: Nilable<string>;
    schema: Nilable<AnySchema<any>>;
    serializer?: Nilable<ResponseSerializer<any>>;
    use?: Nilable<HttpMiddleware | HttpMiddleware[]>;
    validateWithDocumentation?: Nilable<boolean>;
}

Hierarchy

Properties

authorize? deprecated? documentation? format? limit? noAutoEnd? noQueryParams? onError? onParsingFailed? onValidationFailed? onValidationWithDocumentationFailed? parameterFormat? path? schema serializer? use? validateWithDocumentation?

Properties

Optional authorize

authorize?: Nilable<AuthorizeArgumentValue>

Custom 'authorize' options.

Optional deprecated

deprecated?: Nilable<ControllerRouteDeprecatedValue>

Indicates, if route is deprecated or not.

Optional documentation

documentation?: Nilable<{
    callbacks?: {
        [callback: string]: ReferenceObject | CallbackObject;
    };
    deprecated?: boolean;
    description?: string;
    externalDocs?: ExternalDocumentationObject;
    operationId?: string;
    parameters?: (ReferenceObject | ParameterObject)[];
    requestBody?: ReferenceObject | RequestBodyObject;
    responses: ResponsesObject;
    security?: SecurityRequirementObject[];
    servers?: ServerObject[];
    summary?: string;
    tags?: string[];
}>

Optional Swagger documentation.

Type declaration

Optional format

format?: Nilable<HttpInputDataFormat>

The expected data of the input format.

Optional limit

limit?: Nilable<number>

The limit in bytes for the input data.

If that value is defined, but no schema, the input data will be downloaded and written as Buffer using 'buffer()' middleware.

Optional noAutoEnd

noAutoEnd?: Nilable<boolean>

Should do no automatic response.end() call.

Default

false

Optional noQueryParams

noQueryParams?: Nilable<boolean>

Indicates, that query parameters should NOT be parsed.

Optional onError

onError?: Nilable<HttpErrorHandler>

The custom error handler.

Optional onParsingFailed

onParsingFailed?: Nilable<ParseErrorHandler>

Custom parse error handler.

Optional onValidationFailed

onValidationFailed?: Nilable<ValidationFailedHandler>

Custom schema validation error handler.

Optional onValidationWithDocumentationFailed

onValidationWithDocumentationFailed?: Nilable<JsonSchemaValidationFailedHandler>

The handler, that is executed, when object validation with Swagger documentation failed.

Optional parameterFormat

parameterFormat?: Nilable<ControllerParameterFormat>

The custom URL parameter format (only for the route).

@default: ControllerParameterFormat.Default

Optional path

path?: Nilable<string>

The custom path.

schema

schema: Nilable<AnySchema<any>>

An optional schema to use for the validation.

Optional serializer

serializer?: Nilable<ResponseSerializer<any>>

The custom serializer.

Optional use

use?: Nilable<HttpMiddleware | HttpMiddleware[]>

One or more middlewares for the route.

Optional validateWithDocumentation

validateWithDocumentation?: Nilable<boolean>

Validate request data with schema in documentation or not.

Default

false

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc