@myinterview/global-api-sdk
    Preparing search index...

    Interface IGlobalApiCallConfig

    interface IGlobalApiCallConfig {
        adapter?: AxiosAdapterConfig | AxiosAdapterConfig[];
        allowAbsoluteUrls?: boolean;
        allowedSocketPaths?: string | string[] | null;
        auth?: AxiosBasicCredentials;
        baseURL?: string;
        beforeRedirect?: (
            options: Record<string, any>,
            responseDetails: {
                headers: Record<string, string>;
                statusCode: HttpStatusCode;
            },
            requestDetails: {
                headers: Record<string, string>;
                method: string;
                url: string;
            },
        ) => void;
        cancelToken?: CancelToken;
        data?: any;
        decompress?: boolean;
        env?: {
            fetch?: (
                input: string | URL | Request,
                init?: RequestInit,
            ) => Promise<Response>;
            FormData?: new (...args: any[]) => object;
            Request?: new (
                input: string | URL | Request,
                init?: RequestInit,
            ) => Request;
            Response?: new (
                body?:
                    | string
                    | ArrayBuffer
                    | Blob
                    | FormData
                    | URLSearchParams
                    | ArrayBufferView<ArrayBufferLike>
                    | null,
                init?: ResponseInit,
            ) => Response;
        };
        family?: AddressFamily;
        fetchOptions?: | Record<string, any>
        | Omit<RequestInit, "body" | "headers" | "method" | "signal">;
        formDataHeaderPolicy?: "legacy" | "content-only";
        formSerializer?: FormSerializerOptions;
        headers?: {
            "x-myinterview-key": string;
            "x-myinterview-signed": string;
            "x-myinterview-timestamp": string;
        };
        http2Options?: Record<string, any> & { sessionTimeout?: number };
        httpAgent?: any;
        httpsAgent?: any;
        httpVersion?: 1 | 2;
        insecureHTTPParser?: boolean;
        lookup?:
            | (
                (
                    hostname: string,
                    options: object,
                    cb: (
                        err: Error | null,
                        address: LookupAddress | LookupAddress[],
                        family?: AddressFamily,
                    ) => void,
                ) => void
            )
            | (
                (
                    hostname: string,
                    options: object,
                ) => Promise<
                    | LookupAddress
                    | [
                        address: LookupAddressEntry
                        | LookupAddressEntry[],
                        family?: AddressFamily,
                    ],
                >
            );
        maxBodyLength?: number;
        maxContentLength?: number;
        maxRate?: number | [number, number];
        maxRedirects?: number;
        method: Method;
        onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
        onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
        params?: any;
        paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer;
        parseReviver?: (
            this: any,
            key: string,
            value: any,
            context?: { source: string },
        ) => any;
        proxy?: false | AxiosProxyConfig;
        redact?: string[];
        responseEncoding?: StringLiteralsOrString<responseEncoding>;
        responseType?: ResponseType;
        signal?: GenericAbortSignal;
        socketPath?: string | null;
        timeout?: number;
        timeoutErrorMessage?: string;
        transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
        transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
        transitional?: TransitionalOptions;
        transport?: any;
        url: string;
        validateStatus?: ((status: number) => boolean) | null;
        withCredentials?: boolean;
        withXSRFToken?:
            | boolean
            | ((config: InternalAxiosRequestConfig) => boolean | undefined);
        xsrfCookieName?: string;
        xsrfHeaderName?: string;
    }

    Hierarchy

    • AxiosRequestConfig
      • IGlobalApiCallConfig
    Index

    Properties

    adapter?: AxiosAdapterConfig | AxiosAdapterConfig[]
    allowAbsoluteUrls?: boolean
    allowedSocketPaths?: string | string[] | null
    auth?: AxiosBasicCredentials
    baseURL?: string
    beforeRedirect?: (
        options: Record<string, any>,
        responseDetails: {
            headers: Record<string, string>;
            statusCode: HttpStatusCode;
        },
        requestDetails: {
            headers: Record<string, string>;
            method: string;
            url: string;
        },
    ) => void
    cancelToken?: CancelToken
    data?: any
    decompress?: boolean
    env?: {
        fetch?: (
            input: string | URL | Request,
            init?: RequestInit,
        ) => Promise<Response>;
        FormData?: new (...args: any[]) => object;
        Request?: new (
            input: string | URL | Request,
            init?: RequestInit,
        ) => Request;
        Response?: new (
            body?:
                | string
                | ArrayBuffer
                | Blob
                | FormData
                | URLSearchParams
                | ArrayBufferView<ArrayBufferLike>
                | null,
            init?: ResponseInit,
        ) => Response;
    }
    family?: AddressFamily
    fetchOptions?:
        | Record<string, any>
        | Omit<RequestInit, "body" | "headers" | "method" | "signal">
    formDataHeaderPolicy?: "legacy" | "content-only"
    formSerializer?: FormSerializerOptions
    headers?: {
        "x-myinterview-key": string;
        "x-myinterview-signed": string;
        "x-myinterview-timestamp": string;
    }
    http2Options?: Record<string, any> & { sessionTimeout?: number }
    httpAgent?: any
    httpsAgent?: any
    httpVersion?: 1 | 2
    insecureHTTPParser?: boolean
    lookup?:
        | (
            (
                hostname: string,
                options: object,
                cb: (
                    err: Error | null,
                    address: LookupAddress | LookupAddress[],
                    family?: AddressFamily,
                ) => void,
            ) => void
        )
        | (
            (
                hostname: string,
                options: object,
            ) => Promise<
                | LookupAddress
                | [
                    address: LookupAddressEntry
                    | LookupAddressEntry[],
                    family?: AddressFamily,
                ],
            >
        )
    maxBodyLength?: number
    maxContentLength?: number
    maxRate?: number | [number, number]
    maxRedirects?: number
    method: Method
    onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void
    onUploadProgress?: (progressEvent: AxiosProgressEvent) => void
    params?: any
    paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer
    parseReviver?: (
        this: any,
        key: string,
        value: any,
        context?: { source: string },
    ) => any
    proxy?: false | AxiosProxyConfig
    redact?: string[]
    responseEncoding?: StringLiteralsOrString<responseEncoding>
    responseType?: ResponseType
    signal?: GenericAbortSignal
    socketPath?: string | null
    timeout?: number
    timeoutErrorMessage?: string
    transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[]
    transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[]
    transitional?: TransitionalOptions
    transport?: any
    url: string
    validateStatus?: ((status: number) => boolean) | null
    withCredentials?: boolean
    withXSRFToken?:
        | boolean
        | ((config: InternalAxiosRequestConfig) => boolean | undefined)
    xsrfCookieName?: string
    xsrfHeaderName?: string