Skip to content

Commit ef9d2fd

Browse files
cermakjiricermakjiri
committed
📝 Generate updated docs
1 parent 85b2e93 commit ef9d2fd

17 files changed

+176
-172
lines changed

‎packages/@ackee/antonio-auth/docs/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
@ackee/antonio-auth - v4.0.5
1+
@ackee/antonio-auth - v4.1.1
22

3-
# @ackee/antonio-auth - v4.0.5
3+
# @ackee/antonio-auth - v4.1.1
44

55
## Table of contents
66

@@ -26,4 +26,4 @@
2626

2727
#### Defined in
2828

29-
[requestAuthHeaderInterceptor.ts:4](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-auth/src/requestAuthHeaderInterceptor.ts#L4)
29+
[requestAuthHeaderInterceptor.ts:4](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-auth/src/requestAuthHeaderInterceptor.ts#L4)

‎packages/@ackee/antonio-auth/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
"@ackee/antonio-utils": "^4.1.1"
3131
},
3232
"devDependencies": {
33-
"@ackee/petrus": "6.0.2"
33+
"@ackee/petrus": "7.0.0"
3434
},
3535
"peerDependencies": {
3636
"@ackee/petrus": ">=5",

‎packages/@ackee/antonio-core/docs/README.md

+41-22
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
@ackee/antonio-core - v4.0.5
1+
@ackee/antonio-core - v4.1.1
22

3-
# @ackee/antonio-core - v4.0.5
3+
# @ackee/antonio-core - v4.1.1
44

55
## Table of contents
66

@@ -21,6 +21,7 @@
2121
- [GeneralConfig](README.md#generalconfig)
2222
- [RequestBodyData](README.md#requestbodydata)
2323
- [RequestHeaders](README.md#requestheaders)
24+
- [RequestMethod](README.md#requestmethod)
2425
- [RequestSearchParams](README.md#requestsearchparams)
2526
- [RequestUriParams](README.md#requesturiparams)
2627
- [ResponseData](README.md#responsedata)
@@ -46,7 +47,7 @@
4647

4748
#### Defined in
4849

49-
[packages/@ackee/antonio-core/src/modules/core/general-config/index.ts:4](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/core/general-config/index.ts#L4)
50+
[packages/@ackee/antonio-core/src/modules/core/general-config/index.ts:4](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/core/general-config/index.ts#L4)
5051

5152
---
5253

@@ -56,7 +57,7 @@
5657

5758
#### Defined in
5859

59-
[packages/@ackee/antonio-core/src/types.ts:8](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/types.ts#L8)
60+
[packages/@ackee/antonio-core/src/types.ts:8](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/types.ts#L8)
6061

6162
---
6263

@@ -66,7 +67,17 @@
6667

6768
#### Defined in
6869

69-
[packages/@ackee/antonio-core/src/types.ts:86](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/types.ts#L86)
70+
[packages/@ackee/antonio-core/src/types.ts:86](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/types.ts#L86)
71+
72+
---
73+
74+
### RequestMethod
75+
76+
Ƭ **RequestMethod**: `"GET"` \| `"POST"` \| `"PUT"` \| `"PATCH"` \| `"DELETE"` \| `"OPTIONS"` \| `"HEAD"`
77+
78+
#### Defined in
79+
80+
[packages/@ackee/antonio-core/src/types.ts:6](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/types.ts#L6)
7081

7182
---
7283

@@ -101,7 +112,7 @@ api.get('/posts', {
101112

102113
#### Defined in
103114

104-
[packages/@ackee/antonio-core/src/types.ts:129](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/types.ts#L129)
115+
[packages/@ackee/antonio-core/src/types.ts:129](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/types.ts#L129)
105116

106117
---
107118

@@ -127,7 +138,7 @@ console.assert(data.id === '1');
127138

128139
#### Defined in
129140

130-
[packages/@ackee/antonio-core/src/types.ts:103](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/types.ts#L103)
141+
[packages/@ackee/antonio-core/src/types.ts:103](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/types.ts#L103)
131142

132143
---
133144

@@ -137,7 +148,7 @@ console.assert(data.id === '1');
137148

138149
#### Defined in
139150

140-
[packages/@ackee/antonio-core/src/types.ts:74](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/types.ts#L74)
151+
[packages/@ackee/antonio-core/src/types.ts:74](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/types.ts#L74)
141152

142153
---
143154

@@ -213,39 +224,47 @@ function* fetchPosts() {
213224

214225
#### Defined in
215226

216-
[packages/@ackee/antonio-core/src/types.ts:72](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/types.ts#L72)
227+
[packages/@ackee/antonio-core/src/types.ts:72](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/types.ts#L72)
217228

218229
## Functions
219230

220231
### generatorToPromise
221232

222-
▸ **generatorToPromise**<T\>(`it`): `Promise`<T\>
233+
▸ **generatorToPromise**<TReturn, T, TNext\>(`it`): `Promise`<TReturn\>
223234

224235
#### Type parameters
225236

226-
| Name |
227-
| :--- |
228-
| `T` |
237+
| Name | Type |
238+
| :-------- | :------------------------- |
239+
| `TReturn` | `TReturn` = `any` |
240+
| `T` | `T` = `unknown` |
241+
| `TNext` | `TNext` = `TReturn` \| `T` |
229242

230243
#### Parameters
231244

232-
| Name | Type |
233-
| :--- | :------------------------------------------------ |
234-
| `it` | `AsyncGenerator`<any, T\> \| `Generator`<any, T\> |
245+
| Name | Type |
246+
| :--- | :---------------------------------------------------------------------- |
247+
| `it` | `AsyncGenerator`<T, TReturn, TNext\> \| `Generator`<T, TReturn, TNext\> |
235248

236249
#### Returns
237250

238-
`Promise`<T\>
251+
`Promise`<TReturn\>
239252

240253
#### Defined in
241254

242-
[packages/@ackee/antonio-core/src/modules/core/makeRequest.ts:8](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/core/makeRequest.ts#L8)
255+
[packages/@ackee/antonio-core/src/modules/core/makeRequest.ts:8](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/core/makeRequest.ts#L8)
243256

244257
---
245258

246259
### isAntonioError
247260

248-
▸ `Const` **isAntonioError**(`error`): error is AntonioError<unknown\>
261+
▸ `Const` **isAntonioError**<D\>(`error`): error is AntonioError<D\>
262+
263+
#### Type parameters
264+
265+
| Name |
266+
| :--- |
267+
| `D` |
249268

250269
#### Parameters
251270

@@ -255,11 +274,11 @@ function* fetchPosts() {
255274

256275
#### Returns
257276

258-
error is AntonioError<unknown\>
277+
error is AntonioError<D\>
259278

260279
#### Defined in
261280

262-
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:21](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L21)
281+
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:21](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L21)
263282

264283
---
265284

@@ -305,4 +324,4 @@ function* fetchPosts() {
305324

306325
#### Defined in
307326

308-
[packages/@ackee/antonio-core/src/modules/response/utils/runIterableStream.ts:24](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/response/utils/runIterableStream.ts#L24)
327+
[packages/@ackee/antonio-core/src/modules/response/utils/runIterableStream.ts:24](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/response/utils/runIterableStream.ts#L24)

‎packages/@ackee/antonio-core/docs/classes/antonio.md

+41-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[@ackee/antonio-core - v4.0.5](../README.md) / Antonio
1+
[@ackee/antonio-core - v4.1.1](../README.md) / Antonio
22

33
# Class: Antonio<TSuccessDataDefault, TErrorDataDefault\>
44

@@ -30,6 +30,7 @@
3030
- [patch](antonio.md#patch)
3131
- [post](antonio.md#post)
3232
- [put](antonio.md#put)
33+
- [request](antonio.md#request)
3334

3435
## Constructors
3536

@@ -63,7 +64,7 @@ const api = new Antonio({
6364

6465
#### Defined in
6566

66-
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:16](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L16)
67+
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:30](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L30)
6768

6869
## Properties
6970

@@ -73,7 +74,7 @@ const api = new Antonio({
7374

7475
#### Defined in
7576

76-
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:14](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L14)
77+
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:28](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L28)
7778

7879
---
7980

@@ -83,7 +84,7 @@ const api = new Antonio({
8384

8485
#### Defined in
8586

86-
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:16](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L16)
87+
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:30](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L30)
8788

8889
---
8990

@@ -93,7 +94,7 @@ const api = new Antonio({
9394

9495
#### Defined in
9596

96-
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:15](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L15)
97+
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:29](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L29)
9798

9899
## Methods
99100

@@ -121,7 +122,7 @@ const api = new Antonio({
121122

122123
#### Defined in
123124

124-
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:73](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L73)
125+
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:98](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L98)
125126

126127
---
127128

@@ -149,7 +150,7 @@ const api = new Antonio({
149150

150151
#### Defined in
151152

152-
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:66](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L66)
153+
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:91](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L91)
153154

154155
---
155156

@@ -177,7 +178,7 @@ const api = new Antonio({
177178

178179
#### Defined in
179180

180-
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:80](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L80)
181+
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:105](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L105)
181182

182183
---
183184

@@ -205,7 +206,7 @@ const api = new Antonio({
205206

206207
#### Defined in
207208

208-
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:87](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L87)
209+
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:112](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L112)
209210

210211
---
211212

@@ -234,7 +235,7 @@ const api = new Antonio({
234235

235236
#### Defined in
236237

237-
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:58](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L58)
238+
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:83](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L83)
238239

239240
---
240241

@@ -263,7 +264,7 @@ const api = new Antonio({
263264

264265
#### Defined in
265266

266-
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:42](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L42)
267+
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:67](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L67)
267268

268269
---
269270

@@ -292,4 +293,32 @@ const api = new Antonio({
292293

293294
#### Defined in
294295

295-
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:50](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L50)
296+
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:75](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L75)
297+
298+
---
299+
300+
### request
301+
302+
▸ **request**<RM, TSuccessData, TErrorData\>(`props`): `Promise`<[RequestResult](../interfaces/requestresult.md)<TSuccessData\>\>
303+
304+
#### Type parameters
305+
306+
| Name | Type |
307+
| :------------- | :------------------------------------------------ |
308+
| `RM` | `RM`: [RequestMethod](../README.md#requestmethod) |
309+
| `TSuccessData` | `TSuccessData` = `TSuccessDataDefault` |
310+
| `TErrorData` | `TErrorData` = `TErrorDataDefault` |
311+
312+
#### Parameters
313+
314+
| Name | Type |
315+
| :------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
316+
| `props` | `Readonly`<[RequestConfig](../interfaces/requestconfig.md) & `RM` extends `"POST"` \| `"PUT"` \| `"PATCH"` ? { `body`: `Required`<[RequestBodyData](../README.md#requestbodydata)\> ; `method`: `RM` ; `url`: `string` } : { `method`: `RM` ; `url`: `string` }\> |
317+
318+
#### Returns
319+
320+
`Promise`<[RequestResult](../interfaces/requestresult.md)<TSuccessData\>\>
321+
322+
#### Defined in
323+
324+
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:56](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L56)

‎packages/@ackee/antonio-core/docs/classes/antonioerror.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[@ackee/antonio-core - v4.0.5](../README.md) / AntonioError
1+
[@ackee/antonio-core - v4.1.1](../README.md) / AntonioError
22

33
# Class: AntonioError<D\>
44

@@ -62,7 +62,7 @@ Error.constructor
6262

6363
#### Defined in
6464

65-
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:8](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L8)
65+
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:8](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L8)
6666

6767
## Properties
6868

@@ -72,7 +72,7 @@ Error.constructor
7272

7373
#### Defined in
7474

75-
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:7](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L7)
75+
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:7](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L7)
7676

7777
---
7878

@@ -82,7 +82,7 @@ Error.constructor
8282

8383
#### Defined in
8484

85-
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:8](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L8)
85+
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:8](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L8)
8686

8787
---
8888

@@ -110,7 +110,7 @@ Error.name
110110

111111
#### Defined in
112112

113-
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:4](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L4)
113+
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:4](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L4)
114114

115115
---
116116

@@ -120,7 +120,7 @@ Error.name
120120

121121
#### Defined in
122122

123-
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:5](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L5)
123+
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:5](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L5)
124124

125125
---
126126

@@ -130,7 +130,7 @@ Error.name
130130

131131
#### Defined in
132132

133-
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:6](https://github.com/AckeeCZ/antonio/blob/27c90ed/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L6)
133+
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:6](https://github.com/AckeeCZ/antonio/blob/e92d67e/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L6)
134134

135135
---
136136

0 commit comments

Comments
 (0)