@xylabs/axios 4.13.19 → 4.13.21

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.
Files changed (4) hide show
  1. package/README.md +207 -4
  2. package/package.json +13 -7
  3. package/typedoc.json +0 -5
  4. package/xy.config.ts +0 -10
package/README.md CHANGED
@@ -12,13 +12,216 @@
12
12
  [![snyk-badge][]][snyk-link]
13
13
  [![socket-badge][]][socket-link]
14
14
 
15
- Version: 4.13.15
16
15
 
17
- Primary SDK for using XYO Protocol 2.0
16
+ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
18
17
 
19
- ## Documentation
18
+ ## API Documentation
19
+
20
+ **@xylabs/axios**
21
+
22
+ ***
23
+
24
+ ## Classes
25
+
26
+ - [AxiosJson](#classes/AxiosJson)
27
+ - [AxiosJsonUncompressed](#classes/AxiosJsonUncompressed)
28
+
29
+ ## Type Aliases
30
+
31
+ - [RawAxiosJsonRequestConfig](#type-aliases/RawAxiosJsonRequestConfig)
32
+ - [RawAxiosJsonRequestUncompressedConfig](#type-aliases/RawAxiosJsonRequestUncompressedConfig)
33
+
34
+ ## Variables
35
+
36
+ - [axios](#variables/axios)
37
+ - [axiosUncompressed](#variables/axiosUncompressed)
38
+
39
+ ### classes
40
+
41
+ ### <a id="AxiosJson"></a>AxiosJson
42
+
43
+ [**@xylabs/axios**](#../README)
44
+
45
+ ***
46
+
47
+ ## Extends
48
+
49
+ - `Axios`
50
+
51
+ ## Constructors
52
+
53
+ ### Constructor
54
+
55
+ ```ts
56
+ new AxiosJson(config?): AxiosJson;
57
+ ```
58
+
59
+ ### Parameters
60
+
61
+ #### config?
62
+
63
+ [`RawAxiosJsonRequestConfig`](#../type-aliases/RawAxiosJsonRequestConfig)\<`any`\>
64
+
65
+ ### Returns
66
+
67
+ `AxiosJson`
68
+
69
+ ### Overrides
70
+
71
+ ```ts
72
+ Axios.constructor
73
+ ```
74
+
75
+ ## Properties
76
+
77
+ ### defaultLogger?
78
+
79
+ ```ts
80
+ static optional defaultLogger: Logger;
81
+ ```
82
+
83
+ ## Methods
84
+
85
+ ### finalPath()
86
+
87
+ ```ts
88
+ static finalPath(response): any;
89
+ ```
90
+
91
+ ### Parameters
92
+
93
+ #### response
94
+
95
+ `AxiosResponse`
96
+
97
+ ### Returns
98
+
99
+ `any`
100
+
101
+ ### <a id="AxiosJsonUncompressed"></a>AxiosJsonUncompressed
102
+
103
+ [**@xylabs/axios**](#../README)
104
+
105
+ ***
106
+
107
+ ## Extends
108
+
109
+ - `Axios`
110
+
111
+ ## Constructors
112
+
113
+ ### Constructor
114
+
115
+ ```ts
116
+ new AxiosJsonUncompressed(config?): AxiosJsonUncompressed;
117
+ ```
118
+
119
+ ### Parameters
120
+
121
+ #### config?
122
+
123
+ [`RawAxiosJsonRequestUncompressedConfig`](#../type-aliases/RawAxiosJsonRequestUncompressedConfig)\<`any`\>
124
+
125
+ ### Returns
126
+
127
+ `AxiosJsonUncompressed`
128
+
129
+ ### Overrides
130
+
131
+ ```ts
132
+ Axios.constructor
133
+ ```
134
+
135
+ ## Properties
136
+
137
+ ### defaultLogger?
138
+
139
+ ```ts
140
+ static optional defaultLogger: Logger;
141
+ ```
142
+
143
+ ## Methods
144
+
145
+ ### finalPath()
146
+
147
+ ```ts
148
+ static finalPath(response): any;
149
+ ```
150
+
151
+ ### Parameters
152
+
153
+ #### response
154
+
155
+ `AxiosResponse`
156
+
157
+ ### Returns
158
+
159
+ `any`
160
+
161
+ ### type-aliases
162
+
163
+ ### <a id="RawAxiosJsonRequestConfig"></a>RawAxiosJsonRequestConfig
164
+
165
+ [**@xylabs/axios**](#../README)
166
+
167
+ ***
168
+
169
+ ```ts
170
+ type RawAxiosJsonRequestConfig<D> = RawAxiosRequestConfig<D> & object;
171
+ ```
172
+
173
+ ## Type declaration
174
+
175
+ ### compressLength?
176
+
177
+ ```ts
178
+ optional compressLength: number;
179
+ ```
180
+
181
+ ## Type Parameters
182
+
183
+ ### D
184
+
185
+ `D` = `any`
186
+
187
+ ### <a id="RawAxiosJsonRequestUncompressedConfig"></a>RawAxiosJsonRequestUncompressedConfig
188
+
189
+ [**@xylabs/axios**](#../README)
190
+
191
+ ***
192
+
193
+ ```ts
194
+ type RawAxiosJsonRequestUncompressedConfig<D> = RawAxiosRequestConfig<D>;
195
+ ```
196
+
197
+ ## Type Parameters
198
+
199
+ ### D
200
+
201
+ `D` = `any`
202
+
203
+ ### variables
204
+
205
+ ### <a id="axios"></a>axios
206
+
207
+ [**@xylabs/axios**](#../README)
208
+
209
+ ***
210
+
211
+ ```ts
212
+ const axios: AxiosJson;
213
+ ```
214
+
215
+ ### <a id="axiosUncompressed"></a>axiosUncompressed
216
+
217
+ [**@xylabs/axios**](#../README)
218
+
219
+ ***
220
+
221
+ ```ts
222
+ const axiosUncompressed: AxiosJsonUncompressed;
223
+ ```
20
224
 
21
- Coming Soon!
22
225
 
23
226
  Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
24
227
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@xylabs/axios",
3
- "version": "4.13.19",
4
- "description": "Primary SDK for using XYO Protocol 2.0",
3
+ "version": "4.13.21",
4
+ "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "axios",
7
7
  "xylabs",
@@ -29,21 +29,27 @@
29
29
  "exports": {
30
30
  ".": {
31
31
  "types": "./dist/neutral/index.d.ts",
32
+ "source": "./src/index.ts",
32
33
  "default": "./dist/neutral/index.mjs"
33
34
  },
34
35
  "./package.json": "./package.json"
35
36
  },
36
- "module": "dist/neutral/index.mjs",
37
- "types": "dist/neutral/index.d.ts",
37
+ "module": "./dist/neutral/index.mjs",
38
+ "source": "./src/index.ts",
39
+ "types": "./dist/neutral/index.d.ts",
40
+ "files": [
41
+ "dist",
42
+ "src"
43
+ ],
38
44
  "dependencies": {
39
- "@xylabs/logger": "^4.13.19",
45
+ "@xylabs/logger": "^4.13.21",
40
46
  "axios": "^1.10.0",
41
47
  "pako": "^2.1.0"
42
48
  },
43
49
  "devDependencies": {
44
50
  "@types/pako": "^2.0.3",
45
- "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
46
- "@xylabs/tsconfig": "^7.0.0-rc.27",
51
+ "@xylabs/ts-scripts-yarn3": "^7.0.0",
52
+ "@xylabs/tsconfig": "^7.0.0",
47
53
  "typescript": "^5.8.3"
48
54
  },
49
55
  "engines": {
package/typedoc.json DELETED
@@ -1,5 +0,0 @@
1
- {
2
- "$schema": "https://typedoc.org/schema.json",
3
- "entryPoints": ["./src/index.ts"],
4
- "tsconfig": "./tsconfig.typedoc.json"
5
- }
package/xy.config.ts DELETED
@@ -1,10 +0,0 @@
1
- import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
2
- const config: XyTsupConfig = {
3
- compile: {
4
- browser: {},
5
- neutral: { src: true },
6
- node: {},
7
- },
8
- }
9
-
10
- export default config