Interface IApiHandlerParams<Data>

Represents the parameters for an API handler.

interface IApiHandlerParams<Data extends IAnything = IAnything> {
    abortSignal?: AbortSignal;
    fallback?: (e: Error) => void;
    fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise<Response> & (
        input: URL | RequestInfo,
        init?: RequestInit,
    ) => Promise<Response>;
    fetchParams?: () => RequestInit;
    onLoadBegin?: () => void;
    onLoadEnd?: (isOk: boolean) => void;
    origin?: string;
    requestMap?: (url: URL) => URL;
    responseMap?: (
        json: Data,
    ) => Record<string, any> | Promise<Record<string, any>>;
    withAbortSignal?: boolean;
}

Type Parameters

Properties

abortSignal? fallback? fetch? fetchParams? onLoadBegin? onLoadEnd? origin? requestMap? responseMap? withAbortSignal?

Properties

OptionalabortSignal

abortSignal?: AbortSignal

Optionalfallback

fallback?: (e: Error) => void

Optionalfetch

fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise<Response> & (
    input: URL | RequestInfo,
    init?: RequestInit,
) => Promise<Response>

Type declaration

    • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

    • MDN Reference

      Parameters

      • input: URL | RequestInfo
      • Optionalinit: RequestInit

      Returns Promise<Response>

    • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

    • MDN Reference

      Parameters

      • input: URL | RequestInfo
      • Optionalinit: RequestInit

      Returns Promise<Response>

OptionalfetchParams

fetchParams?: () => RequestInit

OptionalonLoadBegin

onLoadBegin?: () => void

OptionalonLoadEnd

onLoadEnd?: (isOk: boolean) => void

Optionalorigin

origin?: string

OptionalrequestMap

requestMap?: (url: URL) => URL

OptionalresponseMap

responseMap?: (json: Data) => Record<string, any> | Promise<Record<string, any>>

OptionalwithAbortSignal

withAbortSignal?: boolean

Settings

Member Visibility

On This Page

Properties