Class Xior

constructor

• new Xior(options?: XiorRequestConfig<any>): Xior

  Parameters

  • Optionaloptions: XiorRequestConfig<any>

  Returns Xior

Optionalconfig

defaults

P

REQI

RESI

Staticcreate

StaticVERSION

interceptors

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

  Returns {
      request: {
          clear: () => void;
          eject: (
              fn: (
                  responseWithConfig: XiorInterceptorRequestConfig,
              ) =>
                  | XiorInterceptorRequestConfig<T>
                  | Promise<XiorInterceptorRequestConfig<T>>,
          ) => void;
          use: (
              fn: (
                  requestConfig: XiorInterceptorRequestConfig,
              ) =>
                  | XiorInterceptorRequestConfig<T>
                  | Promise<XiorInterceptorRequestConfig<T>>,
              onRejected?: null | ((error: any) => any),
              options?: XiorInterceptorOptions,
          ) => (
              requestConfig: XiorInterceptorRequestConfig,
          ) =>
              | XiorInterceptorRequestConfig<T>
              | Promise<XiorInterceptorRequestConfig<T>>;
      };
      response: {
          clear: () => void;
          eject: (
              fn: (
                  config: XiorInterceptorResponseConfig,
              ) =>
                  | XiorInterceptorResponseConfig<any>
                  | Promise<XiorInterceptorResponseConfig<any>>,
          ) => void;
          use: (
              fn: (
                  config: XiorInterceptorResponseConfig,
              ) =>
                  | XiorInterceptorResponseConfig<any>
                  | Promise<XiorInterceptorResponseConfig<any>>,
              onRejected?: null | ((error: XiorError) => any),
          ) => (
              config: XiorInterceptorResponseConfig,
          ) =>
              | XiorInterceptorResponseConfig<any>
              | Promise<XiorInterceptorResponseConfig<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;
  }

_

• _<T>(requestConfig: XiorRequestConfig): Promise<XiorResponse<T>>

  Type Parameters

  • T

  Parameters

  • requestConfig: XiorRequestConfig

  Returns Promise<XiorResponse<T>>

  Deprecated

  for internal use only

cG

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

  create get like method

  Type Parameters

  • T

  Parameters

  • method: string

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

cP

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

  create post like method

  Type Parameters

  • T

  Parameters

  • method: string

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

delete

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

  Type Parameters

  • T = any

  Parameters

  • url: string
  • Optionaloptions: XiorRequestConfig<any>

  Returns Promise<XiorResponse<T>>

get

• get<T = any>(
      url: string,
      options?: XiorRequestConfig<any> & { data?: any },
  ): Promise<XiorResponse<T>>

  Type Parameters

  • T = any

  Parameters

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

    • Optionaldata?: any

      Deprecated

      No data in GET method

  Returns Promise<XiorResponse<T>>

head

• head<T = any>(
      url: string,
      options?: XiorRequestConfig<any> & { data?: any },
  ): Promise<XiorResponse<T>>

  Type Parameters

  • T = any

  Parameters

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

    • Optionaldata?: any

      Deprecated

      No data in HEAD method

  Returns Promise<XiorResponse<T>>

options

• options<T = any>(
      url: string,
      options?: XiorRequestConfig<any> & { data?: any },
  ): Promise<XiorResponse<T>>

  Type Parameters

  • T = any

  Parameters

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

    • Optionaldata?: any

      Deprecated

      No data in OPTIONS method

  Returns Promise<XiorResponse<T>>

patch

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

  Type Parameters

  • T = any

  Parameters

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

  Returns Promise<XiorResponse<T>>

post

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

  Type Parameters

  • T = any

  Parameters

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

  Returns Promise<XiorResponse<T>>

put

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

  Type Parameters

  • T = any

  Parameters

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

  Returns Promise<XiorResponse<T>>

request

• request<T>(options: string | XiorRequestConfig<any>): Promise<XiorResponse<T>>

  Type Parameters

  • T

  Parameters

  • options: string | XiorRequestConfig<any>

  Returns Promise<XiorResponse<T>>