Xivgear Types Documentation
    Preparing search index...

    Interface ApiConfig<SecurityDataType>

    interface ApiConfig<SecurityDataType = unknown> {
        baseApiParams?: Omit<
            RequestParams,
            "signal"
            | "baseUrl"
            | "cancelToken",
        >;
        baseUrl?: string;
        customFetch?: (
            input: RequestInfo | URL,
            init?: RequestInit,
        ) => Promise<Response>;
        securityWorker?: (
            securityData: SecurityDataType | null,
        ) => void | RequestParams | Promise<void | RequestParams>;
    }

    Type Parameters

    • SecurityDataType = unknown
    Index

    Properties

    baseApiParams?: Omit<RequestParams, "signal" | "baseUrl" | "cancelToken">
    baseUrl?: string
    customFetch?: (
        input: RequestInfo | URL,
        init?: RequestInit,
    ) => Promise<Response>

    Type Declaration

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

        • input: RequestInfo | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

    securityWorker?: (
        securityData: SecurityDataType | null,
    ) => void | RequestParams | Promise<void | RequestParams>