express-yaschema-api-handler
    Preparing search index...

    Interface HttpApiHandlerArgs<ReqHeadersT, ReqParamsT, ReqQueryT, ReqBodyT, ResStatusT, ResHeadersT, ResBodyT, ErrResStatusT, ErrResHeadersT, ErrResBodyT, ExtraArgsT>

    interface HttpApiHandlerArgs<
        ReqHeadersT extends AnyHeaders,
        ReqParamsT extends AnyParams,
        ReqQueryT extends AnyQuery,
        ReqBodyT extends AnyBody,
        ResStatusT extends AnyStatus,
        ResHeadersT extends AnyHeaders,
        ResBodyT extends AnyBody,
        ErrResStatusT extends AnyStatus,
        ErrResHeadersT extends AnyHeaders,
        ErrResBodyT extends AnyBody,
        ExtraArgsT extends Record<string, any> = Record<string, never>,
    > {
        express: { next: NextFunction; req: Request; res: Response };
        extras: ExtraArgsT;
        input: {
            body: ReqBodyT;
            headers: ReqHeadersT;
            params: ReqParamsT;
            query: ReqQueryT;
        };
        output: {
            failure: (
                status: ErrResStatusT,
                value: OptionalIfPossiblyUndefined<"headers", ErrResHeadersT> & OptionalIfPossiblyUndefined<
                    "body",
                    ErrResBodyT,
                >,
            ) => Promise<void>;
            success: (
                status: ResStatusT,
                value: OptionalIfPossiblyUndefined<"headers", ResHeadersT> & OptionalIfPossiblyUndefined<
                    "body",
                    ResBodyT,
                >,
            ) => Promise<void>;
        };
    }

    Type Parameters

    • ReqHeadersT extends AnyHeaders
    • ReqParamsT extends AnyParams
    • ReqQueryT extends AnyQuery
    • ReqBodyT extends AnyBody
    • ResStatusT extends AnyStatus
    • ResHeadersT extends AnyHeaders
    • ResBodyT extends AnyBody
    • ErrResStatusT extends AnyStatus
    • ErrResHeadersT extends AnyHeaders
    • ErrResBodyT extends AnyBody
    • ExtraArgsT extends Record<string, any> = Record<string, never>
    Index

    Properties

    express extras input output

    Properties

    express: { next: NextFunction; req: Request; res: Response }
    extras: ExtraArgsT
    input: {
        body: ReqBodyT;
        headers: ReqHeadersT;
        params: ReqParamsT;
        query: ReqQueryT;
    }
    output: {
        failure: (
            status: ErrResStatusT,
            value: OptionalIfPossiblyUndefined<"headers", ErrResHeadersT> & OptionalIfPossiblyUndefined<
                "body",
                ErrResBodyT,
            >,
        ) => Promise<void>;
        success: (
            status: ResStatusT,
            value: OptionalIfPossiblyUndefined<"headers", ResHeadersT> & OptionalIfPossiblyUndefined<
                "body",
                ResBodyT,
            >,
        ) => Promise<void>;
    }

    Settings

    Member Visibility

    On This Page

    Properties