kinetex - v1.0.0-rc.1
    Preparing search index...

    Interface LifecycleHooks

    All lifecycle hook registrations.

    interface LifecycleHooks {
        onBeforeRequest?: (
            (
                req: KinetexRequest,
                ctx: HookContext,
            ) =>
                | void
                | KinetexRequest<HTTPMethod>
                | Promise<void | KinetexRequest<HTTPMethod>>
        )[];
        onAfterRequest?: (
            (req: KinetexRequest, ctx: HookContext) => void | Promise<void>
        )[];
        onBeforeResponse?: (
            (
                res: KinetexResponse<unknown>,
                ctx: HookContext,
            ) =>
                | void
                | KinetexResponse<unknown>
                | Promise<void | KinetexResponse<unknown>>
        )[];
        onAfterResponse?: (
            (
                res: KinetexResponse<unknown>,
                ctx: HookContext,
            ) => void | Promise<void>
        )[];
        onError?: (
            (
                err: unknown,
                ctx: HookContext,
            ) =>
                | void
                | KinetexResponse<unknown>
                | Promise<void | KinetexResponse<unknown>>
        )[];
        onRetry?: ((ctx: RetryContext) => void | Promise<void>)[];
        onUploadProgress?: ProgressCallback[];
        onDownloadProgress?: ProgressCallback[];
    }
    Index

    Properties

    onBeforeRequest?: (
        (
            req: KinetexRequest,
            ctx: HookContext,
        ) =>
            | void
            | KinetexRequest<HTTPMethod>
            | Promise<void | KinetexRequest<HTTPMethod>>
    )[]

    Before the request is sent.

    onAfterRequest?: (
        (req: KinetexRequest, ctx: HookContext) => void | Promise<void>
    )[]

    After the request is sent (before response is processed).

    onBeforeResponse?: (
        (
            res: KinetexResponse<unknown>,
            ctx: HookContext,
        ) =>
            | void
            | KinetexResponse<unknown>
            | Promise<void | KinetexResponse<unknown>>
    )[]

    Before the response is returned to the caller.

    onAfterResponse?: (
        (
            res: KinetexResponse<unknown>,
            ctx: HookContext,
        ) => void | Promise<void>
    )[]

    After the response is returned.

    onError?: (
        (
            err: unknown,
            ctx: HookContext,
        ) =>
            | void
            | KinetexResponse<unknown>
            | Promise<void | KinetexResponse<unknown>>
    )[]

    On error (may return a recovery response).

    onRetry?: ((ctx: RetryContext) => void | Promise<void>)[]

    Before a retry attempt.

    onUploadProgress?: ProgressCallback[]

    On upload progress.

    onDownloadProgress?: ProgressCallback[]

    On download progress.