Class Xior

constructor

• new Xior(options?): Xior

• Parameters

  • Optionaloptions: XiorRequestConfig<any>

  Returns Xior

Optionalconfig

defaults

P

REQI

RESI

StaticVERSION

interceptors

• get interceptors(): {
      request: {
          clear: (() => void);
          eject: ((fn: ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>)) => void);
          use: ((fn: ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>), onRejected?: null | ((error: any) => any), options?: XiorInterceptorOptions) => ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>));
      };
      response: {
          clear: (() => void);
          eject: ((fn: ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>)) => void);
          use: ((fn: ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>), onRejected?: null | ((error: XiorError) => any)) => ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>));
      };
  }

• Returns {
      request: {
          clear: (() => void);
          eject: ((fn: ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>)) => void);
          use: ((fn: ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>), onRejected?: null | ((error: any) => any), options?: XiorInterceptorOptions) => ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>));
      };
      response: {
          clear: (() => void);
          eject: ((fn: ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>)) => void);
          use: ((fn: ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>), onRejected?: null | ((error: XiorError) => any)) => ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>));
      };
  }

  • request: {
        clear: (() => void);
        eject: ((fn: ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>)) => void);
        use: ((fn: ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>), onRejected?: null | ((error: any) => any), options?: XiorInterceptorOptions) => ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>));
    }

    • clear: (() => void)

      • • (): void

        • Returns void

    • eject: ((fn: ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>)) => void)

      • • (fn): void

        • Parameters

          • fn: ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>)
            • • (config): XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>

              • Parameters

                • config: XiorInterceptorRequestConfig<T>

                Returns XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>

          Returns void

    • use: ((fn: ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>), onRejected?: null | ((error: any) => any), options?: XiorInterceptorOptions) => ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>))

      • • (fn, onRejected?, options?): ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>)

        • Parameters

          • fn: ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>)
            • • (config): XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>

              • Parameters

                • config: XiorInterceptorRequestConfig<T>

                Returns XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>

          • OptionalonRejected: null | ((error: any) => any)

            Deprecated

            useless here

          • Optionaloptions: XiorInterceptorOptions

          Returns ((config: XiorInterceptorRequestConfig<T>) => XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>)

          • • (config): XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>

            • Parameters

              • config: XiorInterceptorRequestConfig<T>

              Returns XiorInterceptorRequestConfig<T> | Promise<XiorInterceptorRequestConfig<T>>

  • response: {
        clear: (() => void);
        eject: ((fn: ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>)) => void);
        use: ((fn: ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>), onRejected?: null | ((error: XiorError) => any)) => ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>));
    }

    • clear: (() => void)

      • • (): void

        • Returns void

    • eject: ((fn: ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>)) => void)

      • • (fn): void

        • Parameters

          • fn: ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>)
            • • (config): XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>

              • Parameters

                • config: XiorResponseInterceptorConfig<any>

                Returns XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>

          Returns void

    • use: ((fn: ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>), onRejected?: null | ((error: XiorError) => any)) => ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>))

      • • (fn, onRejected?): ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>)

        • Parameters

          • fn: ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>)
            • • (config): XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>

              • Parameters

                • config: XiorResponseInterceptorConfig<any>

                Returns XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>

          • OptionalonRejected: null | ((error: XiorError) => any)

            error: XiorError | Error | TypeError

          Returns ((config: XiorResponseInterceptorConfig<any>) => XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>)

          • • (config): XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>

            • Parameters

              • config: XiorResponseInterceptorConfig<any>

              Returns XiorResponseInterceptorConfig<any> | Promise<XiorResponseInterceptorConfig<any>>

plugins

• get plugins(): {
      clear: (() => void);
      eject: ((plugin: XiorPlugin) => void);
      use: ((plugin: XiorPlugin) => XiorPlugin);
  }

• Returns {
      clear: (() => void);
      eject: ((plugin: XiorPlugin) => void);
      use: ((plugin: XiorPlugin) => XiorPlugin);
  }

  • clear: (() => void)

    • • (): void

      • Returns void

  • eject: ((plugin: XiorPlugin) => void)

    • • (plugin): void

      • Parameters

        • plugin: XiorPlugin

        Returns void

  • use: ((plugin: XiorPlugin) => XiorPlugin)

    • • (plugin): XiorPlugin

      • Parameters

        • plugin: XiorPlugin

        Returns XiorPlugin

cG

• cG<T>(method): ((url: string, options?: XiorRequestConfig<any>) => Promise<XiorResponse<T>>)

• create get method

  Type Parameters

  • T

  Parameters

  • method: string

  Returns ((url: string, options?: XiorRequestConfig<any>) => Promise<XiorResponse<T>>)

  • • (url, options?): Promise<XiorResponse<T>>

    • Parameters

      • url: string
      • Optionaloptions: XiorRequestConfig<any>

      Returns Promise<XiorResponse<T>>

cP

• cP<T>(method): ((url: string, data?: any, options?: XiorRequestConfig<any>) => Promise<XiorResponse<T>>)

• create post method

  Type Parameters

  • T

  Parameters

  • method: string

  Returns ((url: string, data?: any, options?: XiorRequestConfig<any>) => Promise<XiorResponse<T>>)

  • • (url, data?, options?): Promise<XiorResponse<T>>

    • Parameters

      • url: string
      • Optionaldata: any
      • Optionaloptions: XiorRequestConfig<any>

      Returns Promise<XiorResponse<T>>

delete

• delete<T>(url, options?): Promise<XiorResponse<T>>

• Type Parameters

  • T = any

  Parameters

  • url: string
  • Optionaloptions: XiorRequestConfig<any>

  Returns Promise<XiorResponse<T>>

fetch

• fetch<T>(requestConfig): Promise<XiorResponse<T>>

• Type Parameters

  • T

  Parameters

  • requestConfig: XiorRequestConfig<any>

  Returns Promise<XiorResponse<T>>

get

• get<T>(url, options?): Promise<XiorResponse<T>>

• Type Parameters

  • T = any

  Parameters

  • url: string
  • Optionaloptions: XiorRequestConfig<any> & {
        data?: any;
    }

  Returns Promise<XiorResponse<T>>

head

• head<T>(url, options?): Promise<XiorResponse<T>>

• Type Parameters

  • T = any

  Parameters

  • url: string
  • Optionaloptions: XiorRequestConfig<any> & {
        data?: any;
    }

  Returns Promise<XiorResponse<T>>

options

• options<T>(url, options?): Promise<XiorResponse<T>>

• Type Parameters

  • T = any

  Parameters

  • url: string
  • Optionaloptions: XiorRequestConfig<any> & {
        data?: any;
    }

  Returns Promise<XiorResponse<T>>

patch

• patch<T>(url, data?, options?): Promise<XiorResponse<T>>

• Type Parameters

  • T = any

  Parameters

  • url: string
  • Optionaldata: any
  • Optionaloptions: XiorRequestConfig<any>

  Returns Promise<XiorResponse<T>>

post

• post<T>(url, data?, options?): Promise<XiorResponse<T>>

• Type Parameters

  • T = any

  Parameters

  • url: string
  • Optionaldata: any
  • Optionaloptions: XiorRequestConfig<any>

  Returns Promise<XiorResponse<T>>

put

• put<T>(url, data?, options?): Promise<XiorResponse<T>>

• Type Parameters

  • T = any

  Parameters

  • url: string
  • Optionaldata: any
  • Optionaloptions: XiorRequestConfig<any>

  Returns Promise<XiorResponse<T>>

request

• request<T>(options?): Promise<XiorResponse<T>>

• Type Parameters

  • T

  Parameters

  • Optionaloptions: string | XiorRequestConfig<any>

  Returns Promise<XiorResponse<T>>

Staticcreate

• create(options?): Xior

• Parameters

  • Optionaloptions: XiorRequestConfig<any>

  Returns Xior