Skip to content

Commit 2378107

Browse files
cermakjiricermakjiri
committed
📝 Update docs - API references
1 parent 17ef1cc commit 2378107

File tree

7 files changed

+320
-152
lines changed

7 files changed

+320
-152
lines changed

‎packages/@ackee/antonio-core/docs/api/Class: Antonio.md

+129-72
Large diffs are not rendered by default.

‎packages/@ackee/antonio-core/docs/api/Class: AntonioError.md

+25-13
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## Type parameters
2+
3+
| Name | Type |
4+
| :--- | :-------------- |
5+
| `D` | `D` = `unknown` |
6+
17
## Hierarchy
28

39
- `Error`
@@ -30,33 +36,39 @@
3036

3137
### constructor
3238

33-
• **new AntonioError**(`request`, `response`, `data`)
39+
• **new AntonioError**<D\>(`request`, `response`, `data`)
40+
41+
#### Type parameters
42+
43+
| Name | Type |
44+
| :--- | :-------------- |
45+
| `D` | `D` = `unknown` |
3446

3547
#### Parameters
3648

37-
| Name | Type |
38-
| :--------- | :------------------------------------------- |
39-
| `request` | `Request` |
40-
| `response` | `Response` |
41-
| `data` | [ResponseData](../wiki/Exports#responsedata) |
49+
| Name | Type |
50+
| :--------- | :--------- |
51+
| `request` | `Request` |
52+
| `response` | `Response` |
53+
| `data` | `D` |
4254

4355
#### Overrides
4456

4557
Error.constructor
4658

4759
#### Defined in
4860

49-
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:11](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L11)
61+
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:8](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L8)
5062

5163
## Properties
5264

5365
### data
5466

55-
• **data**: [ResponseData](../wiki/Exports#responsedata)
67+
• **data**: `D`
5668

5769
#### Defined in
5870

59-
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:10](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L10)
71+
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:7](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L7)
6072

6173
---
6274

@@ -66,7 +78,7 @@ Error.constructor
6678

6779
#### Defined in
6880

69-
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:11](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L11)
81+
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:8](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L8)
7082

7183
---
7284

@@ -94,7 +106,7 @@ Error.name
94106

95107
#### Defined in
96108

97-
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:7](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L7)
109+
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:4](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L4)
98110

99111
---
100112

@@ -104,7 +116,7 @@ Error.name
104116

105117
#### Defined in
106118

107-
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:8](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L8)
119+
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:5](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L5)
108120

109121
---
110122

@@ -114,7 +126,7 @@ Error.name
114126

115127
#### Defined in
116128

117-
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:9](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L9)
129+
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:6](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L6)
118130

119131
---
120132

‎packages/@ackee/antonio-core/docs/api/Exports.md

+73-31
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77

88
### Interfaces
99

10-
- [FullRequestConfig](../wiki/Interface:%20FullRequestConfig)
10+
- [RequestConfig](../wiki/Interface:%20RequestConfig)
11+
- [RequestParams](../wiki/Interface:%20RequestParams)
1112
- [RequestResult](../wiki/Interface:%20RequestResult)
1213

1314
### Type aliases
1415

1516
- [GeneralConfig](../wiki/Exports#generalconfig)
1617
- [RequestBodyData](../wiki/Exports#requestbodydata)
17-
- [RequestConfig](../wiki/Exports#requestconfig)
1818
- [RequestHeaders](../wiki/Exports#requestheaders)
1919
- [RequestSearchParams](../wiki/Exports#requestsearchparams)
2020
- [RequestUriParams](../wiki/Exports#requesturiparams)
@@ -28,6 +28,8 @@
2828

2929
### Functions
3030

31+
- [generatorToPromise](../wiki/Exports#generatortopromise)
32+
- [isAntonioError](../wiki/Exports#isantonioerror)
3133
- [runIterableStream](../wiki/Exports#runiterablestream)
3234

3335
## Type aliases
@@ -38,50 +40,39 @@
3840

3941
#### Type declaration
4042

41-
| Name | Type |
42-
| :------------- | :------------------------------------------- |
43-
| `logger` | `RootLogger` |
44-
| `resolverType` | [ResolverType](../wiki/Exports#resolvertype) |
43+
| Name | Type |
44+
| :------- | :----------- |
45+
| `logger` | `RootLogger` |
4546

4647
#### Defined in
4748

48-
[packages/@ackee/antonio-core/src/modules/core/general-config/index.ts:7](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/modules/core/general-config/index.ts#L7)
49+
[packages/@ackee/antonio-core/src/modules/core/general-config/index.ts:4](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/modules/core/general-config/index.ts#L4)
4950

5051
---
5152

5253
### RequestBodyData
5354

54-
Ƭ **RequestBodyData**: `BodyInit` \| `Primitive` \| `PlainObject` \| `any`[]
55+
Ƭ **RequestBodyData**: `BodyInit` \| `Primitive` \| `object` \| `any`[]
5556

5657
#### Defined in
5758

58-
[packages/@ackee/antonio-core/src/types.ts:9](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/types.ts#L9)
59-
60-
---
61-
62-
### RequestConfig
63-
64-
Ƭ **RequestConfig**: `Partial`<[FullRequestConfig](../wiki/Interface:%20FullRequestConfig)\> & { `cancelToken?`: `AbortSignal` }
65-
66-
#### Defined in
67-
68-
[packages/@ackee/antonio-core/src/types.ts:144](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/types.ts#L144)
59+
[packages/@ackee/antonio-core/src/types.ts:7](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/types.ts#L7)
6960

7061
---
7162

7263
### RequestHeaders
7364

74-
Ƭ **RequestHeaders**: `Headers` \| `HeadersInit` \| `Params`
65+
Ƭ **RequestHeaders**: `Headers` \| `HeadersInit` \| { [key: string]: `string`; }
7566

7667
#### Defined in
7768

78-
[packages/@ackee/antonio-core/src/types.ts:91](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/types.ts#L91)
69+
[packages/@ackee/antonio-core/src/types.ts:85](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/types.ts#L85)
7970

8071
---
8172

8273
### RequestSearchParams
8374

84-
Ƭ **RequestSearchParams**: `URLSearchParams` \| `Params`
75+
Ƭ **RequestSearchParams**: `URLSearchParams` \| { [key: string]: `string` \| `number` \| `boolean` \| (`string` \| `number` \| `boolean`)[]; }
8576

8677
An instace of `URLSearchParams` or a plain object.
8778

@@ -103,19 +94,20 @@ api.get('/posts', {
10394
params: {
10495
page: 1,
10596
limit: 20,
97+
userIds: [1, 2, 3],
10698
},
10799
});
108100
```
109101

110102
#### Defined in
111103

112-
[packages/@ackee/antonio-core/src/types.ts:126](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/types.ts#L126)
104+
[packages/@ackee/antonio-core/src/types.ts:128](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/types.ts#L128)
113105

114106
---
115107

116108
### RequestUriParams
117109

118-
Ƭ **RequestUriParams**: `Params`
110+
Ƭ **RequestUriParams**: `Object`
119111

120112
**`example`**
121113

@@ -129,9 +121,13 @@ const { data } =
129121
console.assert(data.id === '1');
130122
```
131123

124+
#### Index signature
125+
126+
▪ [key: `string`]: `string` \| `number`
127+
132128
#### Defined in
133129

134-
[packages/@ackee/antonio-core/src/types.ts:103](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/types.ts#L103)
130+
[packages/@ackee/antonio-core/src/types.ts:102](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/types.ts#L102)
135131

136132
---
137133

@@ -141,17 +137,17 @@ console.assert(data.id === '1');
141137

142138
#### Defined in
143139

144-
[packages/@ackee/antonio-core/src/modules/core/constants/index.ts:7](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/modules/core/constants/index.ts#L7)
140+
[packages/@ackee/antonio-core/src/modules/core/constants/index.ts:7](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/modules/core/constants/index.ts#L7)
145141

146142
---
147143

148144
### ResponseData
149145

150-
Ƭ **ResponseData**: `ArrayBuffer` \| `FormData` \| `ReadableStream`<Uint8Array\> \| `ArrayBufferView` \| `Blob` \| `Primitive` \| `PlainObject` \| `any`[] \| `IterableStream` \| `null`
146+
Ƭ **ResponseData**: `ArrayBuffer` \| `FormData` \| `ReadableStream`<Uint8Array\> \| `ArrayBufferView` \| `Blob` \| `Primitive` \| `object` \| `any`[] \| `IterableStream` \| `null`
151147

152148
#### Defined in
153149

154-
[packages/@ackee/antonio-core/src/types.ts:75](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/types.ts#L75)
150+
[packages/@ackee/antonio-core/src/types.ts:73](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/types.ts#L73)
155151

156152
---
157153

@@ -227,7 +223,7 @@ function* fetchPosts() {
227223

228224
#### Defined in
229225

230-
[packages/@ackee/antonio-core/src/types.ts:73](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/types.ts#L73)
226+
[packages/@ackee/antonio-core/src/types.ts:71](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/types.ts#L71)
231227

232228
## Variables
233229

@@ -244,10 +240,56 @@ function* fetchPosts() {
244240

245241
#### Defined in
246242

247-
[packages/@ackee/antonio-core/src/modules/core/constants/index.ts:1](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/modules/core/constants/index.ts#L1)
243+
[packages/@ackee/antonio-core/src/modules/core/constants/index.ts:1](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/modules/core/constants/index.ts#L1)
248244

249245
## Functions
250246

247+
### generatorToPromise
248+
249+
▸ **generatorToPromise**<T\>(`it`): `Promise`<T\>
250+
251+
#### Type parameters
252+
253+
| Name |
254+
| :--- |
255+
| `T` |
256+
257+
#### Parameters
258+
259+
| Name | Type |
260+
| :--- | :------------------------------------------------ |
261+
| `it` | `AsyncGenerator`<any, T\> \| `Generator`<any, T\> |
262+
263+
#### Returns
264+
265+
`Promise`<T\>
266+
267+
#### Defined in
268+
269+
[packages/@ackee/antonio-core/src/modules/core/makeRequest.ts:8](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/modules/core/makeRequest.ts#L8)
270+
271+
---
272+
273+
### isAntonioError
274+
275+
▸ `Const` **isAntonioError**(`error`): error is AntonioError<unknown\>
276+
277+
#### Parameters
278+
279+
| Name | Type |
280+
| :------ | :---- |
281+
| `error` | `any` |
282+
283+
#### Returns
284+
285+
error is AntonioError<unknown\>
286+
287+
#### Defined in
288+
289+
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:21](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L21)
290+
291+
---
292+
251293
### runIterableStream
252294

253295
▸ **runIterableStream**<T\>(`it`, `onProgress`): `Generator`<T \| Promise<IteratorResult<T, void\>\>, void, any\>
@@ -290,4 +332,4 @@ function* fetchPosts() {
290332

291333
#### Defined in
292334

293-
[packages/@ackee/antonio-core/src/modules/response/utils/runIterableStream.ts:24](https://github.com/AckeeCZ/antonio/blob/f5ba39d/packages/@ackee/antonio-core/src/modules/response/utils/runIterableStream.ts#L24)
335+
[packages/@ackee/antonio-core/src/modules/response/utils/runIterableStream.ts:24](https://github.com/AckeeCZ/antonio/blob/17ef1cc/packages/@ackee/antonio-core/src/modules/response/utils/runIterableStream.ts#L24)

0 commit comments

Comments
 (0)