hipthrusts - v1.2.0
    Preparing search index...

    Type Alias HttpHandlerConfig<TRaw, TInputs, TSafeInputs, TAmbient, TPreAuthOut, TLoadResourcesOut, TFinalAuthOut, TUnsafeResponse, TResponse>

    type HttpHandlerConfig<
        TRaw,
        TInputs = HttpRawInputs,
        TSafeInputs = any,
        TAmbient = never,
        TPreAuthOut = unknown,
        TLoadResourcesOut = unknown,
        TFinalAuthOut = unknown,
        TUnsafeResponse = unknown,
        TResponse = unknown,
    > = {
        execute: (
            context: { inputs: PromiseResolveOrSync<TSafeInputs> } & (
                [TAmbient] extends [never] ? {} : { ambient: TAmbient }
            ) & PromiseResolveOrSync<TPreAuthOut> & PromiseResolveOrSync<
                TLoadResourcesOut,
            > & PromiseResolveOrSync<TFinalAuthOut>,
        ) => PromiseOrSync<TUnsafeResponse>;
        extractAmbient?: (raw: TRaw) => TAmbient;
        extractInputs?: (canonical: HttpRawInputs) => TInputs;
        finalAuthorize: (
            context: { inputs: PromiseResolveOrSync<TSafeInputs> } & (
                [TAmbient] extends [never] ? {} : { ambient: TAmbient }
            ) & PromiseResolveOrSync<TPreAuthOut> & PromiseResolveOrSync<
                TLoadResourcesOut,
            >,
        ) => PromiseOrSync<TFinalAuthOut>;
        loadResources?: (
            context: { inputs: PromiseResolveOrSync<TSafeInputs> } & (
                [TAmbient] extends [never] ? {} : { ambient: TAmbient }
            ) & PromiseResolveOrSync<TPreAuthOut>,
        ) => PromiseOrSync<TLoadResourcesOut>;
        preAuthorize: (
            context: { inputs: PromiseResolveOrSync<TSafeInputs> } & (
                [TAmbient] extends [never] ? {} : { ambient: TAmbient }
            ),
        ) => TPreAuthOut;
        redactResponse: (
            unsafe: PromiseResolveOrSync<TUnsafeResponse>,
            context: { inputs: PromiseResolveOrSync<TSafeInputs> } & (
                [TAmbient] extends [never] ? {} : { ambient: TAmbient }
            ) & PromiseResolveOrSync<TPreAuthOut> & PromiseResolveOrSync<
                TLoadResourcesOut,
            > & PromiseResolveOrSync<TFinalAuthOut>,
        ) => TResponse;
        responseMeta?: ResponseMeta | ((ctx: any) => ResponseMeta);
        sanitizeInputs: (unsafe: TInputs) => TSafeInputs;
    }

    Type Parameters

    • TRaw
    • TInputs = HttpRawInputs
    • TSafeInputs = any
    • TAmbient = never
    • TPreAuthOut = unknown
    • TLoadResourcesOut = unknown
    • TFinalAuthOut = unknown
    • TUnsafeResponse = unknown
    • TResponse = unknown
    Index
    execute: (
        context: { inputs: PromiseResolveOrSync<TSafeInputs> } & (
            [TAmbient] extends [never] ? {} : { ambient: TAmbient }
        ) & PromiseResolveOrSync<TPreAuthOut> & PromiseResolveOrSync<
            TLoadResourcesOut,
        > & PromiseResolveOrSync<TFinalAuthOut>,
    ) => PromiseOrSync<TUnsafeResponse>
    extractAmbient?: (raw: TRaw) => TAmbient
    extractInputs?: (canonical: HttpRawInputs) => TInputs
    finalAuthorize: (
        context: { inputs: PromiseResolveOrSync<TSafeInputs> } & (
            [TAmbient] extends [never] ? {} : { ambient: TAmbient }
        ) & PromiseResolveOrSync<TPreAuthOut> & PromiseResolveOrSync<
            TLoadResourcesOut,
        >,
    ) => PromiseOrSync<TFinalAuthOut>
    loadResources?: (
        context: { inputs: PromiseResolveOrSync<TSafeInputs> } & (
            [TAmbient] extends [never] ? {} : { ambient: TAmbient }
        ) & PromiseResolveOrSync<TPreAuthOut>,
    ) => PromiseOrSync<TLoadResourcesOut>
    preAuthorize: (
        context: { inputs: PromiseResolveOrSync<TSafeInputs> } & (
            [TAmbient] extends [never] ? {} : { ambient: TAmbient }
        ),
    ) => TPreAuthOut
    redactResponse: (
        unsafe: PromiseResolveOrSync<TUnsafeResponse>,
        context: { inputs: PromiseResolveOrSync<TSafeInputs> } & (
            [TAmbient] extends [never] ? {} : { ambient: TAmbient }
        ) & PromiseResolveOrSync<TPreAuthOut> & PromiseResolveOrSync<
            TLoadResourcesOut,
        > & PromiseResolveOrSync<TFinalAuthOut>,
    ) => TResponse
    responseMeta?: ResponseMeta | ((ctx: any) => ResponseMeta)
    sanitizeInputs: (unsafe: TInputs) => TSafeInputs