Class Xior

Index

Constructors

constructor

new Xior(options?: XiorRequestConfig<any>): Xior
Parameters
- Optionaloptions: XiorRequestConfig<any>
Returns Xior
- Defined in src/xior.ts:80

Properties

`Optional`config

config?: XiorRequestConfig<any>

defaults

defaults: XiorInterceptorRequestConfig

P

P: XiorPlugin[] = []

plugins

REQI

REQI: (
    (
        config: XiorInterceptorRequestConfig,
    ) =>
        | XiorInterceptorRequestConfig<T>
        | Promise<XiorInterceptorRequestConfig<T>>
)[] = []

request interceptors

RESI

RESI: {
    fn: (
        config: XiorInterceptorResponseConfig,
    ) =>
        | XiorInterceptorResponseConfig<any>
        | Promise<XiorInterceptorResponseConfig<any>>;
    onRejected?: null | ((error: XiorError) => any);
}[] = []

response interceptors

Type declaration

fn: (
    config: XiorInterceptorResponseConfig,
) =>
    | XiorInterceptorResponseConfig<any>
    | Promise<XiorInterceptorResponseConfig<any>>
OptionalonRejected?: null | ((error: XiorError) => any)
error: XiorError | Error | TypeError

`Static`create

create: (options?: XiorRequestConfig<any>) => Xior = createXior

`Static`VERSION

VERSION: string = '0.7.7'

Accessors

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>>;
    };
}
- Defined in src/xior.ts:101

plugins

get plugins(): {
    clear: () => void;
    eject: (plugin: XiorPlugin) => void;
    use: (plugin: XiorPlugin) => XiorPlugin;
}
Returns {
    clear: () => void;
    eject: (plugin: XiorPlugin) => void;
    use: (plugin: XiorPlugin) => XiorPlugin;
}
- Defined in src/xior.ts:153

Methods

_

_<T>(requestConfig: XiorRequestConfig): Promise<XiorResponse<T>>
Type Parameters
- T
Parameters
- requestConfig: XiorRequestConfig
Returns Promise<XiorResponse<T>>
Deprecated
for internal use only
- Defined in src/xior.ts:207

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>>
- Defined in src/xior.ts:286

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>>
- Defined in src/xior.ts:293

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>>
- Defined in src/xior.ts:330

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>>
- Defined in src/xior.ts:299

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>>
- Defined in src/xior.ts:308

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>>
- Defined in src/xior.ts:334

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>>
- Defined in src/xior.ts:326

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>>
- Defined in src/xior.ts:318

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>>
- Defined in src/xior.ts:322

request

request<T>(options: string | XiorRequestConfig<any>): Promise<XiorResponse<T>>
Type Parameters
- T
Parameters
- options: string | XiorRequestConfig<any>
Returns Promise<XiorResponse<T>>
- Defined in src/xior.ts:168

Class Xior

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Xior

Properties

Optionalconfig

defaults

P

REQI

RESI

Type declaration

fn: ( config: XiorInterceptorResponseConfig,) => | XiorInterceptorResponseConfig<any> | Promise<XiorInterceptorResponseConfig<any>>

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

Staticcreate

StaticVERSION

Accessors

interceptors

plugins

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

Methods

_

Type Parameters

Parameters

Returns Promise<XiorResponse<T>>

Deprecated

cG

Type Parameters

Parameters

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

cP

Type Parameters

Parameters

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

delete

Type Parameters

Parameters

Returns Promise<XiorResponse<T>>

get

Type Parameters

Parameters

Optionaldata?: any

Deprecated

Returns Promise<XiorResponse<T>>

head

Type Parameters

Parameters

Optionaldata?: any

Deprecated

Returns Promise<XiorResponse<T>>

options

Type Parameters

Parameters

Optionaldata?: any

Deprecated

Returns Promise<XiorResponse<T>>

patch

Type Parameters

Parameters

Returns Promise<XiorResponse<T>>

post

Type Parameters

Parameters

Returns Promise<XiorResponse<T>>

put

Type Parameters

Parameters

Returns Promise<XiorResponse<T>>

request

Type Parameters

Parameters

Returns Promise<XiorResponse<T>>

Settings

On This Page

`Optional`config

fn: (
config: XiorInterceptorResponseConfig,
) =>
| XiorInterceptorResponseConfig<any>
| Promise<XiorInterceptorResponseConfig<any>>

`Optional`onRejected?: null | ((error: XiorError) => any)

`Static`create

`Static`VERSION

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

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

`Optional`data?: any

`Optional`data?: any

`Optional`data?: any