zibri
    Preparing search index...

    Interface ValidationServiceInterface

    Interface for a validation service.

    interface ValidationServiceInterface {
        validateBody: (
            body: unknown,
            meta: BodyMetadata,
        ) => void | Promise<void>;
        validateHeaderParam: (
            param: unknown,
            meta: HeaderParamMetadata,
        ) => void | Promise<void>;
        validatePathParam: (
            param: unknown,
            meta: PathParamMetadata,
        ) => void | Promise<void>;
        validateQueryParam: (
            param: unknown,
            meta: QueryParamMetadata,
        ) => void | Promise<void>;
        validateWebsocketRequest: (req: unknown) => void | Promise<void>;
    }

    Implemented by

    Index

    Properties

    validateBody validateHeaderParam validatePathParam validateQueryParam validateWebsocketRequest

    Properties

    validateBody: (body: unknown, meta: BodyMetadata) => void | Promise<void>

    Validate a request/response body.

    validateHeaderParam: (
        param: unknown,
        meta: HeaderParamMetadata,
    ) => void | Promise<void>

    Validate a header param.

    validatePathParam: (
        param: unknown,
        meta: PathParamMetadata,
    ) => void | Promise<void>

    Validate a path parameter.

    validateQueryParam: (
        param: unknown,
        meta: QueryParamMetadata,
    ) => void | Promise<void>

    Validate a query parameter.

    validateWebsocketRequest: (req: unknown) => void | Promise<void>

    Checks if the given value is a valid websocket request. This does NOT check its content like the body or params, but only the base structure.

    Settings

    Member Visibility

    On This Page

    Properties