@xylabs/axios

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Install

Using npm:

npm install {{name}}

Using yarn:

yarn add {{name}}

Using pnpm:

pnpm add {{name}}

Using bun:

bun add {{name}}

License

See the LICENSE file for license rights and limitations (LGPL-3.0-only).

Reference

packages

axios

### .temp-typedoc

  ### classes

    ### <a id="AxiosJson"></a>AxiosJson

@xylabs/axios

Deprecated

use axiosJsonConfig instead

Extends

• Axios

Constructors

Constructor

new AxiosJson(config?): AxiosJson;

Parameters

config?

RawAxiosJsonRequestConfig

Returns

AxiosJson

Overrides

Axios.constructor

Methods

~~axiosConfig()~~

static axiosConfig(config?): RawAxiosJsonRequestConfig;

Parameters

config?

RawAxiosJsonRequestConfig = {}

Returns

RawAxiosJsonRequestConfig

~~create()~~

static create(config?): Axios;

Parameters

config?

RawAxiosJsonRequestConfig

Returns

Axios

  ### functions

    ### <a id="axiosJsonConfig"></a>axiosJsonConfig

@xylabs/axios

function axiosJsonConfig(config?): RawAxiosJsonRequestConfig;

Creates an Axios config preconfigured for JSON requests with optional gzip compression. Request bodies exceeding compressLength (default 1024 bytes) are automatically gzip-compressed.

Parameters

config?

RawAxiosJsonRequestConfig = {}

Base Axios config, optionally including a compressLength threshold

Returns

RawAxiosJsonRequestConfig

A fully configured Axios request config with JSON transforms

  ### variables

    ### <a id="axios"></a>axios

@xylabs/axios

const axios: Axios = axiosJson;

Deprecated

use axiosJson instead

    ### <a id="axiosJson"></a>axiosJson

@xylabs/axios

const axiosJson: Axios;