@xylabs/axios 5.0.84 → 5.0.86
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -22
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -15,6 +15,8 @@
|
|
|
15
15
|
|
|
16
16
|
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
|
|
17
17
|
|
|
18
|
+
|
|
19
|
+
|
|
18
20
|
## Reference
|
|
19
21
|
|
|
20
22
|
**@xylabs/axios**
|
|
@@ -23,16 +25,22 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
|
|
|
23
25
|
|
|
24
26
|
## Classes
|
|
25
27
|
|
|
26
|
-
|
|
28
|
+
| Class | Description |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| [~~AxiosJson~~](#classes/AxiosJson) | - |
|
|
27
31
|
|
|
28
32
|
## Variables
|
|
29
33
|
|
|
30
|
-
|
|
31
|
-
|
|
34
|
+
| Variable | Description |
|
|
35
|
+
| ------ | ------ |
|
|
36
|
+
| [axiosJson](#variables/axiosJson) | - |
|
|
37
|
+
| [~~axios~~](#variables/axios) | - |
|
|
32
38
|
|
|
33
39
|
## Functions
|
|
34
40
|
|
|
35
|
-
|
|
41
|
+
| Function | Description |
|
|
42
|
+
| ------ | ------ |
|
|
43
|
+
| [axiosJsonConfig](#functions/axiosJsonConfig) | Creates an Axios config preconfigured for JSON requests with optional gzip compression. Request bodies exceeding `compressLength` (default 1024 bytes) are automatically gzip-compressed. |
|
|
36
44
|
|
|
37
45
|
### classes
|
|
38
46
|
|
|
@@ -55,14 +63,14 @@ use axiosJsonConfig instead
|
|
|
55
63
|
### Constructor
|
|
56
64
|
|
|
57
65
|
```ts
|
|
58
|
-
new AxiosJson(config
|
|
66
|
+
new AxiosJson(config?: RawAxiosJsonRequestConfig): AxiosJson;
|
|
59
67
|
```
|
|
60
68
|
|
|
61
69
|
### Parameters
|
|
62
70
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
`RawAxiosJsonRequestConfig`
|
|
71
|
+
| Parameter | Type |
|
|
72
|
+
| ------ | ------ |
|
|
73
|
+
| `config?` | `RawAxiosJsonRequestConfig` |
|
|
66
74
|
|
|
67
75
|
### Returns
|
|
68
76
|
|
|
@@ -79,14 +87,14 @@ Axios.constructor
|
|
|
79
87
|
### ~~axiosConfig()~~
|
|
80
88
|
|
|
81
89
|
```ts
|
|
82
|
-
static axiosConfig(config
|
|
90
|
+
static axiosConfig(config?: RawAxiosJsonRequestConfig): RawAxiosJsonRequestConfig;
|
|
83
91
|
```
|
|
84
92
|
|
|
85
93
|
### Parameters
|
|
86
94
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
`
|
|
95
|
+
| Parameter | Type |
|
|
96
|
+
| ------ | ------ |
|
|
97
|
+
| `config` | `RawAxiosJsonRequestConfig` |
|
|
90
98
|
|
|
91
99
|
### Returns
|
|
92
100
|
|
|
@@ -97,14 +105,14 @@ static axiosConfig(config?): RawAxiosJsonRequestConfig;
|
|
|
97
105
|
### ~~create()~~
|
|
98
106
|
|
|
99
107
|
```ts
|
|
100
|
-
static create(config
|
|
108
|
+
static create(config?: RawAxiosJsonRequestConfig): Axios;
|
|
101
109
|
```
|
|
102
110
|
|
|
103
111
|
### Parameters
|
|
104
112
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
`RawAxiosJsonRequestConfig`
|
|
113
|
+
| Parameter | Type |
|
|
114
|
+
| ------ | ------ |
|
|
115
|
+
| `config?` | `RawAxiosJsonRequestConfig` |
|
|
108
116
|
|
|
109
117
|
### Returns
|
|
110
118
|
|
|
@@ -119,7 +127,7 @@ static create(config?): Axios;
|
|
|
119
127
|
***
|
|
120
128
|
|
|
121
129
|
```ts
|
|
122
|
-
function axiosJsonConfig(config
|
|
130
|
+
function axiosJsonConfig(config?: RawAxiosJsonRequestConfig): RawAxiosJsonRequestConfig;
|
|
123
131
|
```
|
|
124
132
|
|
|
125
133
|
Creates an Axios config preconfigured for JSON requests with optional gzip compression.
|
|
@@ -127,11 +135,9 @@ Request bodies exceeding `compressLength` (default 1024 bytes) are automatically
|
|
|
127
135
|
|
|
128
136
|
## Parameters
|
|
129
137
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
`RawAxiosJsonRequestConfig`
|
|
133
|
-
|
|
134
|
-
Base Axios config, optionally including a `compressLength` threshold
|
|
138
|
+
| Parameter | Type | Description |
|
|
139
|
+
| ------ | ------ | ------ |
|
|
140
|
+
| `config` | `RawAxiosJsonRequestConfig` | Base Axios config, optionally including a `compressLength` threshold |
|
|
135
141
|
|
|
136
142
|
## Returns
|
|
137
143
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xylabs/axios",
|
|
3
|
-
"version": "5.0.
|
|
3
|
+
"version": "5.0.86",
|
|
4
4
|
"description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"axios",
|
|
@@ -46,9 +46,9 @@
|
|
|
46
46
|
},
|
|
47
47
|
"devDependencies": {
|
|
48
48
|
"@types/pako": "~2.0.4",
|
|
49
|
-
"@xylabs/logger": "~5.0.
|
|
50
|
-
"@xylabs/ts-scripts-yarn3": "~7.4.
|
|
51
|
-
"@xylabs/tsconfig": "~7.4.
|
|
49
|
+
"@xylabs/logger": "~5.0.86",
|
|
50
|
+
"@xylabs/ts-scripts-yarn3": "~7.4.16",
|
|
51
|
+
"@xylabs/tsconfig": "~7.4.16",
|
|
52
52
|
"axios": "^1.13.6",
|
|
53
53
|
"typescript": "~5.9.3",
|
|
54
54
|
"vitest": "~4.0.18"
|